Skip to content

List organization members

GET
/api/organizations/{organizationId}/members

Returns every member of the organization, including each member's role, who invited them, and when they joined. Accessible to any authenticated member of the organization. Note that there is no direct create endpoint: members join exclusively through the invitation flow (POST /invitations followed by POST /invitations/{id}/accept), which requires the invitee's consent and email ownership.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

organizationId*

Organization identifier

Type
string
Required

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
30
Minimum
0
Maximum
100

Responses

member collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"view": {
  
  
"@id": "string",
  
  
"@type": "string",
  
  
"first": "string",
  
  
"last": "string",
  
  
"previous": "string",
  
  
"next": "string"
  
},
  
"member": [
  
  
{
  
  
  
"@context": "string",
  
  
  
"@id": "string",
  
  
  
"@type": "string",
  
  
  
"id": "5c2e1f9a-3b7d-4c6e-8a1f-0b2d3e4f5a6b",
  
  
  
"user": {
  
  
  
  
"@context": "string",
  
  
  
  
"@id": "string",
  
  
  
  
"@type": "string",
  
  
  
  
"id": "9f1b6c2e-1e4a-4c3a-9c8b-1d2e3f4a5b6c",
  
  
  
  
"email": "jane.doe@example.com",
  
  
  
  
"firstName": "Jane",
  
  
  
  
"lastName": "Doe"
  
  
  
},
  
  
  
"organization": "https://example.com/",
  
  
  
"role": "MANAGER",
  
  
  
"invitedBy": {
  
  
  
  
"@context": "string",
  
  
  
  
"@id": "string",
  
  
  
  
"@type": "string",
  
  
  
  
"id": "9f1b6c2e-1e4a-4c3a-9c8b-1d2e3f4a5b6c",
  
  
  
  
"email": "jane.doe@example.com",
  
  
  
  
"firstName": "Jane",
  
  
  
  
"lastName": "Doe"
  
  
  
},
  
  
  
"joinedAt": "2025-06-15T10:30:00+00:00"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI