Skip to content

Invites API

Endpoints for managing workspace invitations. Users can view, accept, or decline invitations to join workspaces.

SDK equivalent: sdk.invites

List Invites

Retrieve all pending invitations for the current user.

GET /api/invites

Response

json
[
  {
    "workspace": {
      "_id": "workspace-id",
      "name": "Engineering Team",
      "logo": "https://example.com/logo.png"
    }
  }
]

SDK: sdk.invites.getList()


Accept Workspace Invitation

Accept an invitation to join a workspace.

POST /api/invites

Request Body

json
{
  "workspace": "workspace-id",
  "kind": "accept"
}
FieldTypeRequiredDescription
workspacestringYesThe workspace ID to accept
kindstringYesMust be "accept"

Response

Returns 200 OK on success.

SDK: sdk.invites.acceptWorkspace(workspaceId)


Decline Workspace Invitation

Decline an invitation to join a workspace.

POST /api/invites

Request Body

json
{
  "workspace": "workspace-id",
  "kind": "decline"
}
FieldTypeRequiredDescription
workspacestringYesThe workspace ID to decline
kindstringYesMust be "decline"

Response

Returns 200 OK on success.

SDK: sdk.invites.declineWorkspace(workspaceId)

Build SaaS Products Without Limits.