Nango Docs home page

nangoHQ/nango
Sign Up
nangoHQ/nango

Connections

List connections

Reference

Overview

Use Integrations - Reference

Frontend SDK
HTTP API
- Authentication
- Rate limits
- Providers
- Integrations
- Connections
- Scripts
- Syncs
- Actions
- Proxy
- Connect
Backend SDKs
Resource limits

Build Integrations - Reference

CLI
API config (providers.yaml)
Integration scripts
Integration config (nango.yaml)

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

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

string

Will partially match connection IDs or end user profiles.

endUserId

string

endUserId

string

Filter the list of connections based on the given end user id.

endUserOrganizationId

string

endUserOrganizationId

string

Filter the list of connections based on the given end user's organization id.

Query Parameters

connectionId

string

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

string

Will partially match connection IDs or end user profiles.

endUserId

string

Filter the list of connections based on the given end user id.

endUserOrganizationId

string

Filter the list of connections based on the given end user's organization id.

Response

200 - application/json

connections

object[]

connections.id

integer

required

The internal Nango ID used for the connection.

connections.connection_id

string

required

The connection ID used to create the connection.

connections.provider

string

required

The Nango API Configuration.

connections.provider_config_key

string

required

The integration ID used to create the connection (aka Unique Key, Provider Config Key).

connections.created

string

required

Connection creation date.

connections.metadata

object | null

required

Custom metadata attached to the connection

connections.errors

object[]

required

List of connection errors. Ex:

Connection credentials are invalid (type=auth)
Last sync for the connection has failed (type=sync)

connections.errors.type

enum<string>

required

Available options:

auth,

sync

connections.errors.log_id

string

required

connections.end_user

object

required

connections.end_user.id

string

required

Uniquely identifies the end user.

connections.end_user.email

string | null

connections.end_user.display_name

string | null

connections.end_user.organization

object | null

connections.end_user.organization.id

string

required

Uniquely identifies the organization the end user belongs to

connections.end_user.organization.display_name

string | null

Was this page helpful?

Delete an integration Get connection & credentials

twitter linkedin github slack website