API reference
Invites
Email invites into a workspace.
GET/invites
List pending invites
- Session only
Needs a signed-in Dashboard session; API keys are refused.
Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
limitintegerquerycursorstringquery
Responses
200OK
dataInvite[]requiredidstring (uuid)requiredemailstringrequiredrolestringrequiredOne of
admindevelopereditorviewerinvitedBystring (uuid)requiredexpiresAtstring (date-time)requiredcreatedAtstring (date-time)requiredmetaPageMetarequirednext_cursorstring | nullrequiredper_pageintegerrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/invites
Invite someone by email
- Session only
- Idempotency-Key
Sends the invite email; the invite expires after 7 days.
Needs a signed-in Dashboard session; API keys are refused.
Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
Idempotency-KeystringheaderRepeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequest
Request body
emailstring (email)requiredrolestringrequiredOne of
admindevelopereditorviewer
Responses
201Created
dataInviterequiredidstring (uuid)requiredemailstringrequiredrolestringrequiredOne of
admindevelopereditorviewerinvitedBystring (uuid)requiredexpiresAtstring (date-time)requiredcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409ConflictIdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable
DELETE/invites/{id}
Revoke a pending invite
- Session only
Needs a signed-in Dashboard session; API keys are refused.
Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Workspace-Idstring (uuid)headerThe workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.
X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequestidstring (uuid)pathrequired
Responses
200OK
datanullrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/invites/accept
Accept a workspace invite
- Session only
The signed-in user's verified email must match the invite.
Needs a signed-in Dashboard session; API keys are refused.
Parameters
X-Api-VersionstringheaderThe API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.
One of
2026-12-01X-Requested-WithstringheaderRequired on every write made with a signed-in session; without it the request is 403 CsrfRejected. API keys do not send it.
One of
XMLHttpRequest
Request body
tokenstringrequired
Responses
200OK
dataWorkspaceMembershiprequiredworkspaceIdstring (uuid)requirednamestringrequiredslugstringrequiredrolestringrequiredOne of
owneradmindevelopereditorviewerplanKeystringrequired