Sign in

v1

latestOpenAPI 3.1.02026-07-2654172281.3 KB
public_connections
public
Connections

List connections

get/connections

Query parameters

workspaceIdsstring[]

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

includeDeletedboolean

Include deleted connections in the returned results.

limitinteger

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

offsetinteger

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

Response

Successful operation

previousstring
nextstring

Example response

{
  "next": "https://api.airbyte.com/v1/connections?limit=5&offset=10",
  "previous": "https://api.airbyte.com/v1/connections?limit=5&offset=0",
  "data": [
    {
      "name": "test-connection"
    },
    {
      "connection_id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826"
    },
    {
      "sourceId": "49237019-645d-47d4-b45b-5eddf97775ce"
    },
    {
      "destinationId": "al312fs-0ab1-4f72-9ed7-0b8fc27c5826"
    },
    {
      "schedule": {
        "scheduleType": "manual"
      }
    },
    {
      "status": "active"
    },
    {
      "dataResidency": "auto"
    }
  ]
}