members

Embed

<a href="https://hermeticor.com/docs/ref-members"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/d151b738-58df-46f6-bc8a-243b2392522c/social-card.svg?v=3e7ae33eec8b" alt="members" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/members/{userId}

Parameters

userIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/members/{userId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "userId": "string",
  "email": "string",
  "name": "string",
  "role": "owner",
  "listIds": [
    "string"
  ]
}

Schema

userIdstringrequired

emailstringrequired

namestringrequired

rolestringrequired

listIdsstring[]

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

GEThttps://hermeticor.com/v1/shares/{type}/{id}

Who a list, template, campaign or segment is shared with (none = open to all roles that can use it)

Parameters

typestringpathrequired

list | template | campaign | segment

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/shares/{type}/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "restricted": true,
  "items": [
    {
      "userId": "string",
      "email": "string",
      "name": "string",
      "level": "view"
    }
  ]
}

Schema

restrictedbooleanrequired

itemsItemsItem29[]required

Show child parameters

userIdstringrequired

emailstringrequired

namestringrequired

levelstringrequired

view | edit

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

PUThttps://hermeticor.com/v1/shares/{type}/{id}/{userId}

Share with one member (restricts the resource to admins and the people shared with)

Parameters

typestringpathrequired

list | template | campaign | segment

idstringpathrequired

userIdstringpathrequired

Request body

application/json

levelstringrequired

view | edit

{
  "level": "view"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/shares/{type}/{id}/{userId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"level":"view"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "userId": "string",
  "email": "string",
  "name": "string",
  "level": "view"
}

Schema

userIdstringrequired

emailstringrequired

namestringrequired

levelstringrequired

view | edit

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

DELETEhttps://hermeticor.com/v1/shares/{type}/{id}/{userId}

Stop sharing with one member; when the last share goes the resource is open again

Parameters

typestringpathrequired

list | template | campaign | segment

idstringpathrequired

userIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/shares/{type}/{id}/{userId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

GEThttps://hermeticor.com/v1/invitations

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/invitations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "email": "string",
      "role": "string",
      "expiresAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

emailstringrequired

rolestringrequired

expiresAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

POSThttps://hermeticor.com/v1/invitations/{id}/resend

Reissue the invitation link (the old one stops working); the token is returned once

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/invitations/{id}/resend"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "email": "string",
  "role": "owner",
  "token": "string",
  "expiresAt": "2024-01-01T00:00:00Z",
  "emailed": true
}

Schema

idstringrequired

emailstringrequired

rolestringrequired

tokenstringrequired

expiresAtstringrequired

emailedboolean

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

DELETEhttps://hermeticor.com/v1/invitations/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/invitations/{id}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/shares/{type}/{id}/{userId}

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

GEThttps://hermeticor.com/v1/members/by-email/{email}/permissions

One call: a member found by email with their role and effective module read/write grid

Parameters

emailstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/members/by-email/{email}/permissions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "userId": "string",
  "email": "string",
  "name": "string",
  "role": "string",
  "modules": [
    "string"
  ],
  "matrix": {}
}

Schema

userIdstringrequired

emailstringrequired

namestringrequired

rolestringrequired

modulesstring[]required

matrixobjectrequired

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

POSThttps://hermeticor.com/v1/workspace/transfer-ownership

Make another member the owner; you become an admin

Request body

application/json

userIdstringrequired

{
  "userId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workspace/transfer-ownership" \
  -H "Content-Type: application/json" \
  -d '{"userId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/shares/{type}/{id}/{userId}

4XX Default Response

Same as 4XX · GET /v1/members/{userId}

5XX Default Response

Same as 4XX · GET /v1/members/{userId}

Updated Nov 8, 2026

Was this page helpful?