> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # List workspaces > Lists workspaces CliqHub knows, from daemons in your realms: all of them, those of `realm_id` or `org_id`. With `daemon_id` it instead asks that daemon for its workspaces right now and returns its answer as `data` (no paging or sorting). Requires a signed-in user token; with `realm_id`, a realm member (or higher) on that realm. With neither, the results are limited to what you can see. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-workspaces.yaml post /v1/workspaces/get openapi: 3.0.3 info: title: 'CliqHub API: Workspaces' version: 1.0.0 description: >- The workspaces (project folders) daemons have registered, as CliqHub last saw them, with the teams assigned to each. Workspaces are created and changed on the daemon (`cliq init`, `cliq assemble`); CliqHub records them when a run starts and keeps a catalog. You see the workspaces of daemons in your realms. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Workspaces description: >- The workspaces (project folders) daemons have registered, as CliqHub last saw them, with the teams assigned to each. Workspaces are created and changed on the daemon (`cliq init`, `cliq assemble`); CliqHub records them when a run starts and keeps a catalog. You see the workspaces of daemons in your realms. paths: /v1/workspaces/get: post: tags: - Workspaces summary: List workspaces description: >- Lists workspaces CliqHub knows, from daemons in your realms: all of them, those of `realm_id` or `org_id`. With `daemon_id` it instead asks that daemon for its workspaces right now and returns its answer as `data` (no paging or sorting). Requires a signed-in user token; with `realm_id`, a realm member (or higher) on that realm. With neither, the results are limited to what you can see. operationId: POST_v1_workspaces_get requestBody: required: true content: application/json: schema: type: object properties: daemon_id: type: string description: >- Ask this daemon for its workspaces live, instead of reading CliqHub's catalog. realm_id: type: string description: >- Only workspaces on a daemon of this realm, or that ran a run in it org_id: type: string format: uuid description: >- Only workspaces on a daemon in a realm of this org, or that ran a run in the org (narrows what the caller may already see) limit: type: integer minimum: 1 description: Page size (at most 200). Default all. offset: type: integer description: Rows to skip, for paging. sort_by: type: string enum: - name - created_at description: >- Stored list only (400 with daemon_id, which asks the daemon live). sort_dir: type: string enum: - asc - desc description: >- Sort direction with sort_by (default asc); ties are broken by id ascending examples: realm: value: realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b sort_by: name live: summary: Ask a daemon value: daemon_id: 7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d responses: '200': description: >- Catalog: `{ workspaces, total, offset, limit }`. With `daemon_id`: `{ data }`, the daemon's answer (`{ workspaces: [...] }`). content: application/json: schema: type: object properties: ok: type: boolean enum: - true description: Always `true` on success. workspaces: type: array items: $ref: '#/components/schemas/HubWorkspace' total: type: integer offset: type: integer limit: type: integer data: type: object additionalProperties: true description: >- Only with `daemon_id`: the daemon's list (see the Daemon API, List workspaces). required: - ok example: ok: true workspaces: - id: 9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f workspace_id: 9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f path: /home/dev/acme-api workspace_dir: /home/dev/acme-api name: acme-api daemon_id: 7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d registered: true exists: true assembled: true teams: - team_id: 3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4 slug: code-review scope: acme active_runs: [] latest_run: run_id: 0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f state: completed started_at: 1759834200000 created_at: 1759000000000 updated_at: 1759834200000 total: 1 offset: 0 limit: 1 '400': description: >- `invalid_params`: `sort_by` was sent with `daemon_id` (a live read is not sorted). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: >- sort_by applies to the stored workspace list, not a live daemon_id read code: invalid_params '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. `unauthorized`: `daemon_id` was sent with a daemon token: a live read needs a signed-in user. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required unauthorized (endpoint): summary: unauthorized (endpoint) value: ok: false error: Authentication required code: unauthorized '403': description: >- `forbidden`: You can see the realm or organization but your role lacks the required permission. `forbidden`: A daemon token asked for another realm's workspaces. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this forbidden (endpoint): summary: forbidden (endpoint) value: ok: false error: Daemon token is not for this realm code: forbidden '404': description: >- `not_found`: The realm or organization you named does not exist or you cannot see it. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found '422': description: >- `invalid_params`: The body fails the request schema: a field is missing or has the wrong type. `details.issues` lists each problem. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: Required code: invalid_params details: issues: - field: daemon_id message: Required '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: HubWorkspace: type: object properties: id: type: string description: Workspace id (the daemon's). workspace_id: type: string description: Same as `id`. path: type: string description: Folder on the daemon. workspace_dir: type: string description: Same as `path`. name: type: string description: Display name. daemon_id: type: string nullable: true description: The daemon the workspace is on. registered: type: boolean exists: type: boolean assembled: type: boolean description: At least one team is assigned. teams: type: array items: type: object properties: team_id: type: string slug: type: string scope: type: string active_runs: type: array description: Runs going now. items: type: object properties: run_id: type: string state: type: string started_at: type: number latest_run: type: object nullable: true properties: run_id: type: string state: type: string started_at: type: number created_at: type: number updated_at: type: number HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.