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

# List workspaces

`GET /v1/workspaces`

## Request

- Base URL: `https://api.stacksync.com`
- URL: `https://api.stacksync.com/v1/workspaces`
- Auth: HTTP bearer

The workspaces the API key can act in, with the caller's role in each. A workspace API key lists its own workspace.

## Query parameters

- `limit` integer: Maximum number of items returned, at most 200
- `offset` integer: Number of items skipped before the first one returned

## Response `200`

OK

- WorkspaceList
  - `data` Workspace[], required
    - `workspace_id` integer, required
    - `workspace_name` string, required
    - `role` 'viewer' | 'editor' | 'owner', required
    - `default_region` 'besg' | 'usnv', required
  - `has_more` boolean, required: Whether more items follow this page: request the next one with offset + limit
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `400`: Bad Request
- `403`: Forbidden

---

[API](https://skmtc.dev/stacksync/apis/stacksync-api.md) - [All operations](https://skmtc.dev/stacksync/apis/stacksync-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stacksync/apis/stacksync-api/revisions/21f4ba4b214e?raw)