v1

latestOpenAPI 3.1.02026-07-2654172281.3 KB

public_workspaces

public

Workspaces

List workspaces

get/workspaces

Query parameters

workspaceIdsstring[]

The UUIDs of the workspaces you wish to fetch. Empty list will retrieve all allowed workspaces.

includeDeletedboolean

Include deleted workspaces in the returned results.

limitinteger

Set the limit on the number of workspaces returned. The default is 20.

offsetinteger

Set the offset to start at when returning workspaces. The default is 0

Response

Successful operation

previousstring

nextstring

Example response

{
  "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"
  }
}