Members

The members of a workspace

GET /api/workspaces/{workspaceId}/members

Access: workspace:read on the workspace (see ACTIONS for the minimum role); personal access tokens need schema.bases:read.

Parameters

Responses

• 200 Success
  • members array of object required
    • userId string (uuid) required
    • email string | null required
    • name string | null required
    • avatarUrl string | null required
    • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
    • joinedAt string (date-time) required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

The workspace's collaborator directory: members and base-only collaborators of bases the caller can see (emails only for workspace members)

GET /api/workspaces/{workspaceId}/collaborators

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • collaborators array of object required
    • id string (uuid) required
    • name string required
    • email string
    • initials string required
    • color "green" | "amber" | "blue" | "red" | "violet" | "teal" | "pink" | "slate" | … required
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

Change a member's role (owners and creators; only owners grant or change owner)

PATCH /api/workspaces/{workspaceId}/members/{userId}

Access: workspace:manage_members on the workspace (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Request body

• role "owner" | "creator" | "editor" | "commenter" | "read_only" required

Responses

• 200 Success
  • userId string (uuid) required
  • email string | null required
  • name string | null required
  • avatarUrl string | null required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
  • joinedAt string (date-time) required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

Remove a member (their access ends with this request)

DELETE /api/workspaces/{workspaceId}/members/{userId}

Access: workspace:manage_members on the workspace (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 204 Success, no content
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

Everyone with access to a base: workspace members and base collaborators, with their effective role (creators and up)

GET /api/bases/{baseId}/collaborators

Access: base:manage_members on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 200 Success
  • collaborators array of object required
    • userId string (uuid) required
    • email string | null required
    • name string | null required
    • avatarUrl string | null required
    • workspaceRole "owner" | "creator" | "editor" | "commenter" | "read_only" | null required
    • baseRole "creator" | "editor" | "commenter" | "read_only" | null required
    • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)

Set someone's role on a base (creators and up); the effective role is the higher of it and their workspace role

PATCH /api/bases/{baseId}/collaborators/{userId}

Access: base:manage_members on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Request body

• role "creator" | "editor" | "commenter" | "read_only" required

Responses

• 200 Success
  • userId string (uuid) required
  • email string | null required
  • name string | null required
  • avatarUrl string | null required
  • workspaceRole "owner" | "creator" | "editor" | "commenter" | "read_only" | null required
  • baseRole "creator" | "editor" | "commenter" | "read_only" | null required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

Remove someone's base role (a base-only collaborator loses the base at once)

DELETE /api/bases/{baseId}/collaborators/{userId}

Access: base:manage_members on the base (see ACTIONS for the minimum role); signed-in session only (no personal access tokens).

Parameters

Responses

• 204 Success, no content
• 401 Not signed in
• 403 Signed in, but the role is too low
• 404 No such resource, or no access to it
• 429 Too many requests: a rate limit was reached (see Retry-After)