Connections
List connections
- Documentation
- APIs & Templates
- Reference
- Community
- Overview
- Frontend SDK
HTTP API
- Authentication
- Rate limits
Integrations
Connections
Scripts
Syncs
Actions
Proxy
Backend SDKs
- Resource limits
- CLI
- API config (providers.yaml)
- Integration scripts
- Integration config (nango.yaml)
Reference
Use Integrations - Reference
Build Integrations - Reference
Connections
List connections
Returns a list of connections without credentials
GET
/
connection
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
connectionId
string
connectionId
string
Filter the list of connections based on this connection ID.
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
},
{
"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"
}
}
]
}
Query Parameters
connectionId
string
Filter the list of connections based on this connection ID.
Response
200 - application/json
configs
object[]
requiredconfigs.id
integer
requiredThe internal Nango ID used for the connection.
configs.connection_id
string
requiredThe connection ID used to create the connection.
configs.provider
string
requiredThe Nango API Configuration.
configs.provider_config_key
string
requiredThe integration ID used to create the connection (aka Unique Key, Provider Config Key).
configs.created
string
requiredConnection creation date.
configs.metadata
object
Custom metadata attached to the connection
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
},
{
"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"
}
}
]
}