---
title: "List workspaces"
method: GET
path: "/api/v1/workspaces"
tags: ["Workspace"]
---

# List workspaces

`GET /api/v1/workspaces`

Retrieve all workspace objects.

## Query parameters

- `page_size` integer
- `cursor` string
- `id` integer[]
- `name` string
- `organization` integer
- `ordering` 'id' | '-id' | 'name' | '-name'

## Response `200`

OK

- object
  - `pagination` Pagination, required
    - `next` string, uri, nullable — URL for the next page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.
    - `previous` string, uri, nullable — URL for the previous page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.
  - `results` Workspace[], required
    - `id` integer, required — ID of the workspace
    - `name` string, required — Name of the workspace
    - `url` string, uri, required — URL of the workspace
    - `autopilot` boolean, required — Whether to automatically confirm datapoints from previously seen annotations. _Note: Please note that autopilot configuration has been moved to Queue. Option autopilot remains read-only on Workspace and represents autopilot configuration set to queues within a workspace._
    - `organization` string, uri, required — Organization URL.
    - `queues` string[], required — List of queues that belongs to the workspace
    - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
    - `created_by` string, uri, nullable, required — URL of the workspace creator. Might be `null` for workspaces created before April 2026.
    - `created_at` string, date-time, nullable, required — Date of workspace creation. Might be `null` for workspaces created before April 2026.
    - `modified_by` string, uri, nullable, required — User that last modified the object.
    - `modified_at` string, date-time, nullable, required — Timestamp of last modification.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)