AIairbytehq
public_connections
public
Connections

List connections

Changed on
get/connections

Request

  • Base URL
    https://api.airbyte.com/v1
  • URL
    https://api.airbyte.com/v1/connections
  • 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 list connections for. Empty list will retrieve all allowed workspaces.

tagIdsstring[]

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

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

Changes

  • 16d3d680cfffRevision changes
    • info

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

  • 5e3520798637Revision changes
    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      the ///// response's property format changed from no format to set for status

    • warning

      added the new field-filtering enum value to the /////// response property for the response status

    • warning

      added the new locked enum value to the // response property for the response status

    • info

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