List workspaces
List accessible workspaces. Unrestricted Admin keys also see empty workspaces.
/workspacesdata:readThe key must include this project and its owner must still have access.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Query parameters
limitintegerOptionalRecords per page, from 1 to 200.
Default:
50cursorstringOptionalOpaque nextCursor from the preceding response.
archivedbooleanOptionalFilter archive status: true or false.
Response fields
dataobject[]RequiredList accessible workspaces. Unrestricted Admin keys also see empty workspaces.
Child fields
idstringRequiredWorkspace identifier.
namestringRequiredWorkspace name.
archivedbooleanRequiredArchive status.
createdAtISO 8601 timestampRequiredCreation time.
paginationobjectRequiredCursor pagination for resource lists.
Child fields
hasMorebooleanRequiredWhether another page exists.
nextCursorstring | nullRequiredPass this unchanged as cursor with the same key, path, limit and filters.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.