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

# List workspaces

`GET /workspaces`

Returns a paginated list of workspaces.

## Query parameters

- `limit` number — The number of items to return
- `cursor` string, cuid — The cursor to return the next page of items

## Headers

- `x-client-id` string, cuid, required — The ID of the client

## Response `200`

Workspaces

- PaginatedWorkspaces
  - `data` Workspace[], required
    - `id` string, cuid, required — The ID of the workspace
    - `name` string, required — The name of the workspace
    - `createdAt` string, date-time, required — The date and time of the creation for the workspace. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
    - `updatedAt` string, date-time, required — The date and time of the last update for the workspace. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
    - `archivedAt` string, date-time, nullable, required — The date and time the workspace was archived. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).
    - `clientId` string, cuid, required — The ID of the client
  - `pagination` Pagination, required
    - `nextCursor` string — The cursor to return the next page of items
    - `previousCursor` string — The cursor to return the previous page of items
    - `limit` integer, required — The number of items to return
    - `total` integer, required — The total number of items

## Other responses

- `401` — Unauthorized
- `422` — The validation error(s)
- `429` — Rate limit exceeded
- `500` — Internal server error

---

[API](https://skmtc.net/steuerboard/apis/steuerboard-api.md) · [All operations](https://skmtc.net/steuerboard/apis/steuerboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steuerboard/steuerboard-api/revisions/80748f72965e/schema)