Skip to main content
GET
/
api
/
v1
/
connections
List integration connections in the caller’s organization
curl --request GET \
  --url https://api.staging.getmodus.com/api/v1/connections \
  --header 'Authorization: Bearer <token>'
{
  "connections": [
    {
      "id": "7a3f9d2c-1111-4000-a000-000000000abc",
      "name": "Production Warehouse",
      "type": "postgresql"
    }
  ],
  "nextPageToken": "eyJjcmVhdGVkQXQiOiIyMDI2"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageToken
string

Opaque page token from a previous response's nextPageToken. Omit for the first page. AIP-158.

Example:

"eyJjcmVhdGVkQXQiOiIyMDI2"

​
pageSize
number

Max items per page. Defaults to 25, clamped to 100. AIP-158.

Required range: 1 <= x <= 100
Example:

25

​
type
string

Filter by effective integration category (case-sensitive exact match).

Example:

"postgresql"

Response

​
connections
object[]
required

Page of integration connections the caller can use. Connections the caller cannot access are filtered out (not enumerated).

​
nextPageToken
string | null
required

Opaque token for the next page; null when this was the last page. Pass as pageToken on the next request. AIP-158.

Example:

"eyJjcmVhdGVkQXQiOiIyMDI2"