Skip to main content
GET
/
base
/
{baseId}
/
collaborators
cURL
curl --request GET \
  --url http://127.0.0.1:3000/api/base/{baseId}/collaborators \
  --header 'Authorization: Bearer <token>'
{
  "collaborators": [
    {
      "userId": "<string>",
      "userName": "<string>",
      "email": "<string>",
      "role": "owner",
      "avatar": "<string>",
      "createdTime": "<string>",
      "type": "user",
      "resourceType": "space",
      "isSystem": true,
      "billable": true,
      "base": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  ],
  "total": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
baseId
string
required

Query Parameters

​
includeSystem
boolean | null
​
skip
number | null
​
take
number | null
​
search
string
​
type
enum<string>
Available options:
user,
department
​
role
enum<string>[]
Available options:
owner,
creator,
editor,
commenter,
viewer

Response

200 - application/json

Successful response, return base collaborator list.

​
collaborators
object[]
required
​
total
number
required
Last modified on December 10, 2025