Skip to content
Relay Port

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-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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.

  • limitintegerquery

  • cursorstringquery

Responses

200OK
  • dataInvite[]required

  • idstring (uuid)required

  • emailstringrequired

  • rolestringrequired

    One of admin developer editor viewer

  • invitedBystring (uuid)required

  • expiresAtstring (date-time)required

  • createdAtstring (date-time)required

  • metaPageMetarequired

  • next_cursorstring | nullrequired

  • per_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-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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-Keystringheader

    Repeating a request with the same key within 24 hours returns the first response (header Idempotent-Replayed: true) instead of running it again.

  • X-Requested-Withstringheader

    Required 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)required

  • rolestringrequired

    One of admin developer editor viewer

Responses

201Created
  • dataInviterequired

  • idstring (uuid)required

  • emailstringrequired

  • rolestringrequired

    One of admin developer editor viewer

  • invitedBystring (uuid)required

  • expiresAtstring (date-time)required

  • createdAtstring (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-Versionstringheader

    The 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-01

  • X-Workspace-Idstring (uuid)header

    The 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-Withstringheader

    Required 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

  • idstring (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-Versionstringheader

    The 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-01

  • X-Requested-Withstringheader

    Required 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
  • dataWorkspaceMembershiprequired

  • workspaceIdstring (uuid)required

  • namestringrequired

  • slugstringrequired

  • rolestringrequired

    One of owner admin developer editor viewer

  • planKeystringrequired

400InvalidJson
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenInviteEmailMismatchWorkspaceSuspended
404InviteInvalid
422ValidationError