Invitations

Pending invitations of a workspace (owners and creators)

GET /api/workspaces/{workspaceId}/invitations

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

Parameters

Responses

• 200 Success
  • invitations array of object required
    • id string (uuid) required
    • workspaceId string (uuid) required
    • baseId string (uuid) | null required
    • interfaceId string (uuid) | null required
    • email string required
    • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
    • invitedByName string | null required
    • expiresAt string (date-time) required
    • sentAt string (date-time) required
    • createdAt string (date-time) required
    • emailSent boolean
• 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)

Invite someone by email (owners and creators; only owners invite owners)

POST /api/workspaces/{workspaceId}/invitations

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

Parameters

Request body

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

Responses

• 201 Success
  • id string (uuid) required
  • workspaceId string (uuid) required
  • baseId string (uuid) | null required
  • interfaceId string (uuid) | null required
  • email string required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
  • invitedByName string | null required
  • expiresAt string (date-time) required
  • sentAt string (date-time) required
  • createdAt string (date-time) required
  • emailSent boolean
• 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)

Send an invitation again with a new token and expiry

POST /api/workspaces/{workspaceId}/invitations/{invitationId}/resend

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

Parameters

Responses

• 200 Success
  • id string (uuid) required
  • workspaceId string (uuid) required
  • baseId string (uuid) | null required
  • interfaceId string (uuid) | null required
  • email string required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
  • invitedByName string | null required
  • expiresAt string (date-time) required
  • sentAt string (date-time) required
  • createdAt string (date-time) required
  • emailSent boolean
• 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)

Revoke an invitation

DELETE /api/workspaces/{workspaceId}/invitations/{invitationId}

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)

Read the invitation for an emailed token

GET /api/invitations/{token}

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

Parameters

Responses

• 200 Success
  • workspaceId string (uuid) required
  • workspaceName string required
  • baseId string (uuid) | null required
  • baseName string | null required
  • interfaceId string (uuid) | null required
  • interfaceName string | null required
  • inviterName string | null required
  • email string required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
  • expiresAt string (date-time) required
  • status "pending" | "expired" | "revoked" | "accepted" required
  • emailMatches boolean required
  • alreadyMember boolean required
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

Accept an invitation (needs a verified email matching the invitation's)

POST /api/invitations/{token}/accept

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

Parameters

Responses

• 200 Success
  • id string (uuid) required
  • name string required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" | null required
  • createdAt string (date-time) required
  • updatedAt string (date-time) required
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

Pending invitations to a base (creators and up)

GET /api/bases/{baseId}/invitations

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
  • invitations array of object required
    • id string (uuid) required
    • workspaceId string (uuid) required
    • baseId string (uuid) | null required
    • interfaceId string (uuid) | null required
    • email string required
    • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
    • invitedByName string | null required
    • expiresAt string (date-time) required
    • sentAt string (date-time) required
    • createdAt string (date-time) required
    • emailSent boolean
• 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)

Invite someone to this base only, by email (creators and up)

POST /api/bases/{baseId}/invitations

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

Parameters

Request body

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

Responses

• 201 Success
  • id string (uuid) required
  • workspaceId string (uuid) required
  • baseId string (uuid) | null required
  • interfaceId string (uuid) | null required
  • email string required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
  • invitedByName string | null required
  • expiresAt string (date-time) required
  • sentAt string (date-time) required
  • createdAt string (date-time) required
  • emailSent boolean
• 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)

Send a base invitation again with a new token and expiry

POST /api/bases/{baseId}/invitations/{invitationId}/resend

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
  • id string (uuid) required
  • workspaceId string (uuid) required
  • baseId string (uuid) | null required
  • interfaceId string (uuid) | null required
  • email string required
  • role "owner" | "creator" | "editor" | "commenter" | "read_only" required
  • invitedByName string | null required
  • expiresAt string (date-time) required
  • sentAt string (date-time) required
  • createdAt string (date-time) required
  • emailSent boolean
• 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)

Revoke a base invitation

DELETE /api/bases/{baseId}/invitations/{invitationId}

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)