Get list of collaborator

GET

/v1/organizations/:organizationId/collaborators/

Get list of collaborator

Required Permission: base.people.organizationCollaborator.list

Get list of collaborator

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer

optional

Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.

limit integer

optional

Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size.

sort string

optional

Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.

Match pattern: ^[\w.]*((:asc)|(:desc))?$

role string

optional

owneradmineditorviewerunassigned

email string

optional

≤ 256 characters

tags array

optional

onlyUsers boolean

optional

Responses

200 Response application/json

status boolean required

data object required

items array [object] required

id string required

Match pattern: ^[a-fA-F0-9]{24}$

organization string required

Match pattern: ^[a-fA-F0-9]{24}$

role string required

owner admin editor viewer unassigned

tags array required

user object optional

id string required

Match pattern: ^[a-fA-F0-9]{24}$

email string required

≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email

firstName string required

≤ 128 characters

lastName string required

≤ 128 characters

picture string optional

role string required

admin adminViewer user serviceAccount

ssoUser boolean required

detected object required

createdBy string required

Match pattern: ^[a-fA-F0-9]{24}$

updatedAt string required

createdAt string required

totalDocs integer required

≥ -9007199254740991 · ≤ 9007199254740991

limit integer required

≥ -9007199254740991 · ≤ 9007199254740991

hasPrevPage boolean required

hasNextPage boolean required

page integer required

≥ -9007199254740991 · ≤ 9007199254740991

totalPages integer required

≥ -9007199254740991 · ≤ 9007199254740991

prevPage integer required

≥ -9007199254740991 · ≤ 9007199254740991

nextPage integer required

≥ -9007199254740991 · ≤ 9007199254740991

{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organization": "string",
                "role": "owner",
                "tags": [
                    "string"
                ],
                "user": {
                    "id": "string",
                    "email": "[email protected]",
                    "firstName": "string",
                    "lastName": "string",
                    "picture": "string",
                    "role": "admin",
                    "ssoUser": true
                },
                "detected": {},
                "createdBy": "string",
                "updatedAt": "string",
                "createdAt": "string"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}