AIairbytehq
public_workspaces
public
Workspaces

List workspaces

Changed on
get/workspaces

Request

  • Base URL
    https://api.airbyte.com/v1
  • URL
    https://api.airbyte.com/v1/workspaces
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: /applications/token

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

Changes

  • eb889125bd9dRevision changes
    • info

      the response's property default value auto was removed for the status

    • info

      removed the auto enum value from the // response property for the response status

    • info

      removed the eu enum value from the // response property for the response status

    • info

      removed the us enum value from the // response property for the response status

  • 6003f9d50fceRevision changes
    • info

      added the required property // to the response with the status