Connections
List connections
Reference
Use Integrations - Reference
- Frontend SDK
- HTTP API
- Authentication
- Rate limits
- Providers
- Integrations
- Connections
- Scripts
- Syncs
- Actions
- Proxy
- Connect
- Backend SDKs
Build Integrations - Reference
Connections
List connections
Returns a list of connections without credentials
GET
/
connection
curl --request GET \
--url https://api.nango.dev/connection
{
"connections": [
{
"id": 1,
"connection_id": "test-1",
"provider": "slack",
"provider_config_key": "slack-nango-community",
"created": "2023-06-03T14:53:22.051Z",
"metadata": null,
"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"
},
"errors": [],
"end_user": {
"id": "your-internal-id",
"email": "user@example.com",
"organization": {
"id": "user-organization-id"
}
}
}
]
}
{
"connections": [
{
"id": 1,
"connection_id": "test-1",
"provider": "slack",
"provider_config_key": "slack-nango-community",
"created": "2023-06-03T14:53:22.051Z",
"metadata": null,
"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"
},
"errors": [],
"end_user": {
"id": "your-internal-id",
"email": "user@example.com",
"organization": {
"id": "user-organization-id"
}
}
}
]
}
Query Parameters
Will exactly match a given connectionId. Can return multiple connections with the same ID across integrations
Will partially match connection IDs or end user profiles.
Filter the list of connections based on the given end user id.
Filter the list of connections based on the given end user's organization id.
Response
200 - application/json
Successfully returned a list of connections
The internal Nango ID used for the connection.
The connection ID used to create the connection.
The Nango API Configuration.
The integration ID used to create the connection (aka Unique Key, Provider Config Key).
Connection creation date.
Custom metadata attached to the connection
Uniquely identifies the end user.
Was this page helpful?
curl --request GET \
--url https://api.nango.dev/connection
{
"connections": [
{
"id": 1,
"connection_id": "test-1",
"provider": "slack",
"provider_config_key": "slack-nango-community",
"created": "2023-06-03T14:53:22.051Z",
"metadata": null,
"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"
},
"errors": [],
"end_user": {
"id": "your-internal-id",
"email": "user@example.com",
"organization": {
"id": "user-organization-id"
}
}
}
]
}