---
updatedAt: 2025-03-06T23:15:23.000Z
agentTools:
  projectIndex: https://reference.airbyte.com/llms.txt
---

# List workspaces

> 📘 All accessible workspaces will be returned if the `workspaceIds` param is left as an empty value
>
> Optionally, you can filter by specific workspaces by providing one or more workspace IDs separated by commas in the query parameter. e.g. `workspaceIds=6ae537d7-0cc0-4c68-a7c2-204a8261e4c3,f214ddfe-21fc-4418-8851-df19496486cd`

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Workspaces",
    "version": "1.0.0",
    "description": "Programmatically control Airbyte Cloud, OSS & Enterprise."
  },
  "servers": [
    {
      "url": "https://api.airbyte.com/v1",
      "description": "Airbyte API v1"
    }
  ],
  "paths": {
    "/workspaces": {
      "get": {
        "tags": [
          "public_workspaces",
          "public",
          "Workspaces"
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspacesResponse"
                }
              }
            },
            "description": "Successful operation"
          },
          "403": {
            "description": "Not allowed"
          },
          "404": {
            "description": "Not found"
          }
        },
        "operationId": "listWorkspaces",
        "x-speakeasy-alias": "listWorkspaces",
        "x-speakeasy-group": "Workspaces",
        "summary": "List workspaces",
        "x-speakeasy-entity-operation": "Workspace#list",
        "parameters": [
          {
            "name": "workspaceIds",
            "description": "The UUIDs of the workspaces you wish to fetch. Empty list will retrieve all allowed workspaces.",
            "schema": {
              "type": "array",
              "items": {
                "format": "uuid",
                "type": "string"
              }
            },
            "in": "query",
            "required": false
          },
          {
            "name": "includeDeleted",
            "description": "Include deleted workspaces in the returned results.",
            "schema": {
              "default": false,
              "type": "boolean"
            },
            "in": "query",
            "required": false
          },
          {
            "name": "limit",
            "description": "Set the limit on the number of workspaces returned. The default is 20.",
            "schema": {
              "format": "int32",
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 20
            },
            "in": "query"
          },
          {
            "name": "offset",
            "description": "Set the offset to start at when returning workspaces. The default is 0",
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 0,
              "default": 0
            },
            "in": "query"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "GeographyEnum": {
        "type": "string",
        "enum": [
          "auto",
          "us",
          "eu"
        ],
        "default": "auto",
        "x-speakeasy-component": true
      },
      "WorkspaceResponse": {
        "title": "Root Type for WorkspaceResponse",
        "description": "Provides details of a single workspace.",
        "type": "object",
        "required": [
          "workspaceId",
          "name",
          "dataResidency",
          "notifications"
        ],
        "properties": {
          "workspaceId": {
            "format": "UUID",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "dataResidency": {
            "$ref": "#/components/schemas/GeographyEnum"
          },
          "notifications": {
            "$ref": "#/components/schemas/NotificationsConfig"
          }
        },
        "x-speakeasy-entity": "Workspace",
        "x-speakeasy-param-suppress-computed-diff": true,
        "x-speakeasy-component": true
      },
      "NotificationsConfig": {
        "description": "Configures workspace notifications.",
        "type": "object",
        "properties": {
          "failure": {
            "$ref": "#/components/schemas/NotificationConfig"
          },
          "success": {
            "$ref": "#/components/schemas/NotificationConfig"
          },
          "connectionUpdate": {
            "$ref": "#/components/schemas/NotificationConfig"
          },
          "connectionUpdateActionRequired": {
            "$ref": "#/components/schemas/NotificationConfig"
          },
          "syncDisabled": {
            "$ref": "#/components/schemas/NotificationConfig"
          },
          "syncDisabledWarning": {
            "$ref": "#/components/schemas/NotificationConfig"
          }
        },
        "x-speakeasy-entity": "Workspace",
        "x-speakeasy-param-suppress-computed-diff": true,
        "x-speakeasy-component": true
      },
      "NotificationConfig": {
        "description": "Configures a notification.",
        "type": "object",
        "properties": {
          "email": {
            "$ref": "#/components/schemas/EmailNotificationConfig"
          },
          "webhook": {
            "$ref": "#/components/schemas/WebhookNotificationConfig"
          }
        },
        "x-speakeasy-entity": "Workspace",
        "x-speakeasy-param-suppress-computed-diff": true,
        "x-speakeasy-component": true
      },
      "WebhookNotificationConfig": {
        "description": "Configures a webhook notification.",
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "url": {
            "type": "string"
          }
        },
        "x-speakeasy-entity": "Workspace",
        "x-speakeasy-param-suppress-computed-diff": true,
        "x-speakeasy-component": true
      },
      "EmailNotificationConfig": {
        "description": "Configures an email notification.",
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          }
        },
        "x-speakeasy-entity": "Workspace",
        "x-speakeasy-param-suppress-computed-diff": true,
        "x-speakeasy-component": true
      },
      "WorkspacesResponse": {
        "title": "Root Type for WorkspacesResponse",
        "description": "",
        "required": [
          "data"
        ],
        "type": "object",
        "properties": {
          "previous": {
            "type": "string"
          },
          "next": {
            "type": "string"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkspaceResponse"
            }
          }
        },
        "example": {
          "next": "https://api.airbyte.com/v1/workspaces?limit=5&offset=10",
          "previous": "https://api.airbyte.com/v1/workspaces?limit=5&offset=0",
          "data": {
            "workspaceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
            "name": "Acme Company",
            "dataResidency": "auto"
          }
        },
        "x-speakeasy-component": true
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```