Skip to main content
GET
/
connection
List connections (deprecated)
curl --request GET \
  --url https://api.nango.dev/connection \
  --header 'Authorization: Bearer <token>'
{
"connections": [
  {
    "id": 1,
    "connection_id": "test-1",
    "provider": "slack",
    "provider_config_key": "slack-nango-community",
    "created": "2023-06-03T14:53:22.051Z",
    "metadata": null,
    "tags": {
      "end_user_id": "your-internal-id",
      "end_user_email": "user@example.com",
      "organization_id": "user-organization-id"
    },
    "errors": [{ "type": "auth", "log_id": "VrnbtykXJFckCm3HP93t"}]
  },
  {
    "id": 2,
    "connection_id": "test-2",
    "provider": "slack",
    "provider_config_key": "slack-nango-community",
    "created": "2023-06-03T15:00:14.945Z",
    "metadata": {
      "bot_id": "some-uuid"
    },
    "tags": {
      "end_user_id": "your-internal-id",
      "end_user_email": "user@example.com",
      "organization_id": "user-organization-id"
    },
    "errors": []
  }
]
}
Requires an API key with one of: environment:connections:list or environment:connections:list_credentials. Learn more about API key scopes.
{
"connections": [
  {
    "id": 1,
    "connection_id": "test-1",
    "provider": "slack",
    "provider_config_key": "slack-nango-community",
    "created": "2023-06-03T14:53:22.051Z",
    "metadata": null,
    "tags": {
      "end_user_id": "your-internal-id",
      "end_user_email": "user@example.com",
      "organization_id": "user-organization-id"
    },
    "errors": [{ "type": "auth", "log_id": "VrnbtykXJFckCm3HP93t"}]
  },
  {
    "id": 2,
    "connection_id": "test-2",
    "provider": "slack",
    "provider_config_key": "slack-nango-community",
    "created": "2023-06-03T15:00:14.945Z",
    "metadata": {
      "bot_id": "some-uuid"
    },
    "tags": {
      "end_user_id": "your-internal-id",
      "end_user_email": "user@example.com",
      "organization_id": "user-organization-id"
    },
    "errors": []
  }
]
}

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Query Parameters

​
connectionId
string

Will exactly match a given connectionId. Can return multiple connections with the same ID across integrations

​
search
string

Will partially match connection IDs or end user profiles.

​
endUserId
string

Deprecated. Prefer filtering connections by tag (e.g. tags[end_user_id]=...).

​
endUserOrganizationId
string

Deprecated. Prefer filtering connections by tag (e.g. tags[organization_id]=...).

​
tags
object

Filter the list of connections based on connection tags. All provided tags must match. Connection tags (key/value strings). Keys are normalized to lowercase.

​
limit
integer

Limit the number of connections returned

​
page
integer

Page number for paginated results

Response

200 - application/json

Successfully returned a list of connections

​
connections
object[]
required