Skip to main content
GET
/
connections
List connections
curl --request GET \
  --url https://api.bundleup.io/v1/connections \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "integrationId": "<string>",
    "isValid": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "refreshedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token

Query Parameters

offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 1000
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100
integration_id
string

Filter by integration ID

integration_identifier
string

Filter by integration identifier

external_id
string

Filter by external ID

Response

List of connections retrieved successfully

id
string
required

Unique connection identifier

integrationId
string
required

ID of the integration this connection belongs to

isValid
boolean
required

Whether connection is valid

createdAt
string<date-time>
required

When the connection was created

updatedAt
string<date-time>
required

When the connection was last updated

externalId
string | null

External system identifier

expiresAt
string<date-time> | null

When the connection expires

refreshedAt
string<date-time> | null

When the connection was last refreshed