API reference
Workspaces
The workspaces a signed-in user belongs to and their product modules.
GET/modules
List the product modules and whether they are on
A module is on when its stage is ga (or beta) and the workspace's plan includes it; a key's scopes of a module that is off answer 403 ModuleNotAvailable.
curl https://api.relayport.dev/modules \
-H "Authorization: Bearer $RELAYPORT_API_KEY"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.
Responses
200OK
dataModuleState[]requiredidstringrequiredOne of
publishinginboxautomationsanalyticsadsstagestringrequiredOne of
gabetaplannedenabledbooleanrequirednavobject[]requiredareastringrequiredOne of
workspaceadmingroupstringrequiredOne of
homeworkspacedeveloperaccountlabelstringrequiredpathstringrequirediconstringrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
GET/workspaces
List the workspaces you belong to
- Session only
Send X-Workspace-Id with one of these ids on every workspace call made with a session.
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-01
Responses
200OK
dataWorkspaceMembership[]requiredworkspaceIdstring (uuid)requirednamestringrequiredslugstringrequiredrolestringrequiredOne of
owneradmindevelopereditorviewerplanKeystringrequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
422ValidationError
POST/workspaces
Create a workspace
- Session only
You become its owner. It starts on the Free plan with a default brand.
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
namestringrequired
Responses
201Created
dataWorkspacerequiredidstring (uuid)requirednamestringrequiredslugstringrequiredplanKeystringrequiredstatusstringrequiredOne of
activesuspendedtimezonestringrequiredsettingsobjectrequiredduplicateGuardbooleanrequireddefaultQueueIdstring (uuid) | nullrequiredcreatedAtstring (date-time)required
400InvalidJson
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
422ValidationError
429RateLimited
503RateLimiterUnavailable
GET/workspaces/{id}
Get a workspace
- 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-01idstring (uuid)pathrequired
Responses
200OK
dataWorkspacerequiredidstring (uuid)requirednamestringrequiredslugstringrequiredplanKeystringrequiredstatusstringrequiredOne of
activesuspendedtimezonestringrequiredsettingsobjectrequiredduplicateGuardbooleanrequireddefaultQueueIdstring (uuid) | nullrequiredcreatedAtstring (date-time)required
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
PATCH/workspaces/{id}
Update a workspace
- Session only
Name, time zone and settings. Needs the manageWorkspace role.
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
XMLHttpRequestidstring (uuid)pathrequired
Request body
namestringtimezonestringsettingsobjectduplicateGuardbooleandefaultQueueIdstring (uuid) | null
Responses
200OK
dataWorkspacerequiredidstring (uuid)requirednamestringrequiredslugstringrequiredplanKeystringrequiredstatusstringrequiredOne of
activesuspendedtimezonestringrequiredsettingsobjectrequiredduplicateGuardbooleanrequireddefaultQueueIdstring (uuid) | nullrequiredcreatedAtstring (date-time)required