> ## 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. # Get a workspace > Returns one workspace with the teams assigned to it and when each was assigned. Send `id` or `workspace_id`. Requires a realm member (or higher) on the realm that owns the workspace given by `workspace_id` or `id`. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-workspaces.yaml post /v1/workspaces/get_by_id 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_by_id: post: tags: - Workspaces summary: Get a workspace description: >- Returns one workspace with the teams assigned to it and when each was assigned. Send `id` or `workspace_id`. Requires a realm member (or higher) on the realm that owns the workspace given by `workspace_id` or `id`. operationId: POST_v1_workspaces_get_by_id requestBody: required: true content: application/json: schema: type: object properties: id: type: string minLength: 1 description: The workspace id. workspace_id: type: string minLength: 1 description: Same as `id` (either may be sent). examples: default: value: id: 9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f responses: '200': description: Success. content: application/json: schema: type: object required: - ok - workspace - teams properties: ok: type: boolean enum: - true description: Always `true` on success. workspace: $ref: '#/components/schemas/HubWorkspace' teams: type: array items: type: object properties: team_id: type: string scope: type: string nullable: true slug: type: string nullable: true assembled_at: type: number example: ok: true workspace: 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 teams: - team_id: 3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4 scope: acme slug: code-review assembled_at: 1759000100000 '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: You can see the record but your role in its realm is too low or lacks the required permission. 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 '404': description: >- `not_found`: The workspace does not exist or is in a realm you cannot see (404 rather than 403, so its existence is not revealed). `not_found`: No workspace has this id, or its daemon is not in a realm you belong to. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found not_found (endpoint): summary: not_found (endpoint) value: ok: false error: workspace '9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f' not found code: 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: 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.