API ReferenceMembers
List members
Returns all members of the organisation, newest first.
Supports cursor-based pagination via the cursor and limit parameters.
Requires members:read scope.
Authorization
bearerAuth members:readAuthorizationBearer <token>
API token from your dashboard.
Format: so_live_... (production) or so_test_... (test mode).
Tokens carry one or more scopes. Request only the scopes your integration needs:
| Scope | Grants |
|---|---|
media:read | List and retrieve files |
media:write | Upload and delete files |
logs:read | Read log entries |
logs:write | Ingest log entries |
cases:read | Read cases |
cases:write | Create and update cases |
apps:read | Read apps |
apps:write | Submit apps |
usage:read | Read quota usage |
members:read | List organisation members |
members:write | Invite and remove members |
billing:read | Read billing and subscription info |
tokens:write | Create and revoke API tokens |
In: header
Scope: members:read
Path Parameters
orgId*string
Organisation ID (ULID)
Query Parameters
limit?integer
Number of results per page. Default 50, maximum 100.
Default
50Range
1 <= value <= 100cursor?string
Opaque pagination cursor returned as next_cursor in the previous response.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/orgs/01HZXXXXXXXXXXXXXXXXXXXXX/members"{
"members": [
{
"id": "string",
"name": "string",
"email": "[email protected]",
"avatar": "string",
"role": {
"id": "rol_01HXYZ",
"name": "Member",
"isSystem": true
},
"joinedAt": "2019-08-24T14:15:22Z"
}
],
"nextCursor": "string"
}{
"error": {
"code": "unauthorized",
"message": "missing or invalid authorization token"
}
}{
"error": {
"code": "forbidden",
"message": "token does not have the required scope"
}
}{
"error": {
"code": "internal",
"message": "an unexpected error occurred"
}
}