API reference
API keys
Scoped rp_live_ and rp_test_ keys and the log of the requests made to the workspace, managed from a signed-in session.
GET/api-keys
List API keys
- Session only
Newest first, revoked and expired keys included. The secret is never shown again.
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
dataApiKey[]requiredidstring (uuid)requirednamestringrequiredprefixstringrequiredmodestringrequiredOne of
livetestscopesstring[]requiredbrandIds(string (uuid))[] | nullrequiredapiVersionstringrequiredcreatedBystring (uuid)requiredlastUsedAtstring (date-time) | nullrequiredexpiresAtstring (date-time) | nullrequiredrevokedAtstring (date-time) | nullrequiredreplacedBystring (uuid) | nullrequiredcreatedAtstring (date-time)requiredmetaPageMetarequirednext_cursorstring | nullrequiredper_pageintegerrequired
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/api-keys
Create an API key
- Session only
The response carries the secret (rp_live_... or rp_test_...) once; store it. A test key reaches only test platforms such as sandbox. Scopes must be available to the workspace: unknown or unavailable scopes are 422 with details.unknown and details.unavailable. brandIds restricts the key to those brands.
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-KeystringheaderOnly blocks a second request with the same key while the first runs (409 IdempotencyInProgress). The response carries a secret, so it is never stored or replayed: a retry with the same key runs again and issues a new secret.
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
namestringrequiredmodestringrequiredOne of
livetestscopesstring[]requiredbrandIds(string (uuid))[]expiresAtstring (date-time)
Responses
201Created
dataIssuedApiKeyrequiredidstring (uuid)requirednamestringrequiredprefixstringrequiredmodestringrequiredOne of
livetestscopesstring[]requiredbrandIds(string (uuid))[] | nullrequiredapiVersionstringrequiredcreatedBystring (uuid)requiredlastUsedAtstring (date-time) | nullrequiredexpiresAtstring (date-time) | nullrequiredrevokedAtstring (date-time) | nullrequiredreplacedBystring (uuid) | nullrequiredcreatedAtstring (date-time)requiredsecretstringrequiredThe key (rp_live_... or rp_test_...), shown once
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409IdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable
PATCH/api-keys/{id}
Update an API key's name, scopes, brands or expiry
- Session only
A revoked, replaced or expired key cannot change: 409 Conflict with details.reason.
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
Request body
namestringscopesstring[]brandIds(string (uuid))[] | nullexpiresAtstring (date-time) | null
Responses
200OK
dataApiKeyrequiredidstring (uuid)requirednamestringrequiredprefixstringrequiredmodestringrequiredOne of
livetestscopesstring[]requiredbrandIds(string (uuid))[] | nullrequiredapiVersionstringrequiredcreatedBystring (uuid)requiredlastUsedAtstring (date-time) | nullrequiredexpiresAtstring (date-time) | nullrequiredrevokedAtstring (date-time) | nullrequiredreplacedBystring (uuid) | nullrequiredcreatedAtstring (date-time)required
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409Conflict
422ValidationError
429RateLimited
503RateLimiterUnavailable
DELETE/api-keys/{id}
Revoke an API key
- Session only
The key stops working at once, and so do the connect links it created.
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
204No Content
No fields.
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
POST/api-keys/{id}/rotate
Rotate an API key
- Session only
Issues a new key with the same scopes and brands and returns its secret once. The old key keeps working for overlapHours (default 24, at most 168); when the overlap ends it stops, together with the connect links it created.
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-KeystringheaderOnly blocks a second request with the same key while the first runs (409 IdempotencyInProgress). The response carries a secret, so it is never stored or replayed: a retry with the same key runs again and issues a new secret.
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
Request body
overlapHoursinteger
Responses
201Created
dataIssuedApiKeyrequiredidstring (uuid)requirednamestringrequiredprefixstringrequiredmodestringrequiredOne of
livetestscopesstring[]requiredbrandIds(string (uuid))[] | nullrequiredapiVersionstringrequiredcreatedBystring (uuid)requiredlastUsedAtstring (date-time) | nullrequiredexpiresAtstring (date-time) | nullrequiredrevokedAtstring (date-time) | nullrequiredreplacedBystring (uuid) | nullrequiredcreatedAtstring (date-time)requiredsecretstringrequiredThe key (rp_live_... or rp_test_...), shown once
400InvalidJsonWorkspaceRequired
401InvalidApiKeyUnauthenticated
403CsrfRejectedForbiddenWorkspaceSuspended
404NotFound
409ConflictIdempotencyInProgress
413PayloadTooLarge
422IdempotencyKeyReusedValidationError
429RateLimited
503RateLimiterUnavailable
GET/api-keys/scopes
List the scopes a key can hold
- Session only
Grouped by module. A scope of a planned module, or of a module the plan does not include, is listed with available false.
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.
Responses
200OK
dataScopeListing[]requiredmodulestringrequiredstagestringrequiredOne of
gabetaplannedscopesobject[]requiredscopestringrequiredavailablebooleanrequiredreason"planned"
400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable
GET/request-logs
List the workspace's recent API requests
- Session only
Newest first, kept for the plan's log retention. livemode tells live-key requests from test-key requests; session requests from the Dashboard are logged as live. Filter by status (404 or 4xx), method, keyId, path and a time range.
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.
limitintegerquerycursorstringquerystatusstringquerymethodstringqueryOne of
GETHEADPOSTPUTPATCHDELETEkeyIdstring (uuid)querypathstringqueryfromstring (date-time)querytostring (date-time)query
Responses
200OK
dataRequestLog[]requiredidstringrequiredmethodstringrequiredpathstringrequiredstatusintegerrequiredprincipalTypestringrequiredOne of
userapi_keyprincipalIdstringrequiredkeyPrefixstring | nullrequiredlivemodebooleanrequiredlatencyMsintegerrequiredrequestIdstringrequiredcreatedAtstring (date-time)requiredmetaPageMetarequirednext_cursorstring | nullrequiredper_pageintegerrequired