Skip to navigation
API Referenceworkspaces

List Workspaces

List the workspaces on your account, newest first, as a cursor-paginated page.

Authentication

AuthorizationBearer

A workspace key (rray_live_…, bound to one workspace) or the account’s platform key. Platform keys name the target workspace with RRay-Workspace-Id. See Credentials.

Query parameters

statusstring or nullOptional
namestring or nullOptional
limitintegerOptional1-100Defaults to 20

Rows per page (1–100, default 20).

cursorstring or nullOptional

Opaque pagination token. Omit for the first page (newest rows first). To page, copy pagination.next_cursor (older rows) or pagination.prev_cursor (newer rows) from the previous response into this parameter — do not build it yourself: the walk direction and the active filter set are encoded in the token, and reusing a cursor with a different filter set is rejected (validation.cursor_filters_mismatch).

Response

Successful Response
datalist of objects
This page of rows, newest first.
paginationobject
Where you are in the list and how to walk it.
objectstringOptionalDefaults to list

Always list.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error