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

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

Response

List of connections retrieved successfully

​
id
string
required

Unique connection identifier

​
authToken
string
required

Authentication token (sensitive - may be omitted in responses)

​
refreshAttempts
integer
required

Number of refresh attempts

​
isEnabled
boolean
required

Whether connection is enabled

​
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

​
workspaceId
string
required

ID of the workspace this connection belongs to

​
integrationId
string
required

ID of the integration this connection belongs to

​
refreshToken
string | null

Refresh token (sensitive - may be omitted in responses)

​
externalId
string | null

External system identifier

​
metadata
object

Connection metadata JSON

​
refreshAt
string<date-time> | null

When the connection should be refreshed

​
expiresAt
string<date-time> | null

When the connection expires

​
refreshedAt
string<date-time> | null

When the connection was last refreshed

​
integration
object