---
title: "List workspaces"
method: GET
path: "/workspaces"
tags: ["public_workspaces", "public", "Workspaces"]
---

# List workspaces

`GET /workspaces`

## Query parameters

- `workspaceIds` string[]
- `includeDeleted` boolean
- `limit` integer
- `offset` integer

## Response `200`

Successful operation

- WorkspacesResponse
  - `previous` string
  - `next` string
  - `data` WorkspaceResponse[], required
    - `workspaceId` string, UUID, required
    - `name` string, required
    - `dataResidency` string, required
    - `notifications` NotificationsConfig, required — Configures workspace notifications.
      - `failure` NotificationConfig — Configures a notification.
        - `email` EmailNotificationConfig — Configures an email notification.
          - `enabled` boolean
        - `webhook` WebhookNotificationConfig — Configures a webhook notification.
          - `enabled` boolean
          - `url` string
      - `success` NotificationConfig — Configures a notification.
        - `email` EmailNotificationConfig — Configures an email notification.
          - `enabled` boolean
        - `webhook` WebhookNotificationConfig — Configures a webhook notification.
          - `enabled` boolean
          - `url` string
      - `connectionUpdate` NotificationConfig — Configures a notification.
        - `email` EmailNotificationConfig — Configures an email notification.
          - `enabled` boolean
        - `webhook` WebhookNotificationConfig — Configures a webhook notification.
          - `enabled` boolean
          - `url` string
      - `connectionUpdateActionRequired` NotificationConfig — Configures a notification.
        - `email` EmailNotificationConfig — Configures an email notification.
          - `enabled` boolean
        - `webhook` WebhookNotificationConfig — Configures a webhook notification.
          - `enabled` boolean
          - `url` string
      - `syncDisabled` NotificationConfig — Configures a notification.
        - `email` EmailNotificationConfig — Configures an email notification.
          - `enabled` boolean
        - `webhook` WebhookNotificationConfig — Configures a webhook notification.
          - `enabled` boolean
          - `url` string
      - `syncDisabledWarning` NotificationConfig — Configures a notification.
        - `email` EmailNotificationConfig — Configures an email notification.
          - `enabled` boolean
        - `webhook` WebhookNotificationConfig — Configures a webhook notification.
          - `enabled` boolean
          - `url` string

## Other responses

- `403` — Not allowed
- `404` — Not found

---

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