Get connection & credentials

Returns a specific connection with credentials

The response content depends on the API authentication type (OAuth 2, OAuth 1, API key, Basic auth).

If you do not want to deal with collecting & injecting credentials in requests for multiple authentication types, use the Proxy(step-by-step guide).

Every time you fetch the connection with this API endpoint, Nango will check if the access token has expired. If it has, it will refresh it.

We recommend you always fetch the token just before you use it to make sure it is fresh!

Path Parameters

connectionId

string

required

The connection ID used to create the connection.

Query Parameters

provider_config_key

string

required

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

force_refresh

boolean

If true, Nango will attempt to refresh the access access token regardless of its expiration status (false by default).

refresh_token

boolean

If true, return the refresh token as part of the response (false by default).