List workspaces
List the workspaces available to the current dashboard user.
Endpoint
GET
/api/v1/workspacesAuthentication
| Operation class | Authentication | Minimum role | API key |
|---|---|---|---|
| dashboard-session-api | Dashboard session cookie; mutations also require X-CX-Request: 1. | session | Not allowed |
Parameters
This operation has no path, query, or header parameters.
Request body
This operation has no request body.
Example
curl --request GET 'https://operade.ai/api/v1/workspaces' \ --cookie 'cx_session=YOUR_SESSION_COOKIE'
Responses
| Status | Description | Content |
|---|---|---|
4XX | Handled client error | application/json: ErrorResponse |
200 | Successful Response | application/json: WorkspaceListResponse |
4XX application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | ErrorResponse | — | No | Yes | — | — |
error | object | ErrorItem | — | No | Yes | — | — |
error.code | string | — | — | No | Yes | — | — |
error.details | object | — | — | No | No | — | — |
error.message | string | — | — | No | Yes | — | — |
200 application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | WorkspaceListResponse | — | No | Yes | — | — |
items | array<WorkspaceMembership> | — | — | No | Yes | — | — |
items[] | object | WorkspaceMembership | — | No | Yes | — | — |
items[].id | string | — | — | No | Yes | — | — |
items[].name | string | — | — | No | Yes | — | — |
items[].role | string | — | — | No | Yes | "owner", "admin", "member" | — |
items[].slug | string | — | — | No | Yes | — | — |
Response example
{
"items": []
}Errors
Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.
| Status | Code | Description |
|---|---|---|
401 | unauthenticated | Authentication is missing, invalid, or revoked. |