Skip to content
Relay Port

API reference

Members

The people in a workspace and their roles.

GET/members

List workspace members

  • Session only

email and name are null for a member whose account was deleted.

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
  • dataMember[]required

  • userIdstring (uuid)required

  • emailstring | nullrequired

    null once the member's account is deleted

  • namestring | nullrequired

  • rolestringrequired

    One of owner admin developer editor viewer

  • joinedAtstring (date-time)required

  • metaPageMetarequired

  • next_cursorstring | nullrequired

  • per_pageintegerrequired

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable

PATCH/members/{userId}

Change a member's role

  • Session only

Only a higher role may change a member, and the last owner cannot be demoted.

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

  • userIdstring (uuid)pathrequired

Request body

  • rolestringrequired

    One of owner admin developer editor viewer

Responses

200OK
  • dataMemberrequired

  • userIdstring (uuid)required

  • emailstring | nullrequired

    null once the member's account is deleted

  • namestring | nullrequired

  • rolestringrequired

    One of owner admin developer editor viewer

  • joinedAtstring (date-time)required

400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409Conflict
422ValidationError
429RateLimited
503RateLimiterUnavailable

DELETE/members/{userId}

Remove a member, or leave the workspace

  • Session only

Any member may remove themselves; removing someone else needs the manageWorkspace role. The last owner cannot leave.

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

  • userIdstring (uuid)pathrequired

Responses

200OK
  • datanullrequired

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409Conflict
422ValidationError
429RateLimited
503RateLimiterUnavailable