Get a connection (deprecated)
curl --request GET \
--url https://api.nango.dev/connection/{connectionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nango.dev/connection/{connectionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nango.dev/connection/{connectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nango.dev/connection/{connectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nango.dev/connection/{connectionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nango.dev/connection/{connectionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nango.dev/connection/{connectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 123,
"connection_id": "<string>",
"provider_config_key": "<string>",
"provider": "<string>",
"errors": [
{
"type": "auth",
"log_id": "VrnbtykXJFckCm3HP93t"
}
],
"metadata": {},
"connection_config": {},
"tags": {},
"created_at": "<string>",
"updated_at": "<string>",
"last_fetched_at": "<string>",
"credentials": {
"oauth_token": "<string>",
"oauth_token_secret": "<string>",
"type": "OAUTH1",
"raw": {}
},
"end_user": {
"id": "<string>",
"email": "<string>",
"display_name": "<string>",
"tags": {},
"organization": {
"id": "<string>",
"display_name": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Deprecated
Get connection & credentials (deprecated)
Returns a specific connection with credentials. This endpoint is deprecated, use the /connections/ endpoint instead.
GET
/
connection
/
{connectionId}
Get a connection (deprecated)
curl --request GET \
--url https://api.nango.dev/connection/{connectionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nango.dev/connection/{connectionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nango.dev/connection/{connectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nango.dev/connection/{connectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nango.dev/connection/{connectionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nango.dev/connection/{connectionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nango.dev/connection/{connectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 123,
"connection_id": "<string>",
"provider_config_key": "<string>",
"provider": "<string>",
"errors": [
{
"type": "auth",
"log_id": "VrnbtykXJFckCm3HP93t"
}
],
"metadata": {},
"connection_config": {},
"tags": {},
"created_at": "<string>",
"updated_at": "<string>",
"last_fetched_at": "<string>",
"credentials": {
"oauth_token": "<string>",
"oauth_token_secret": "<string>",
"type": "OAUTH1",
"raw": {}
},
"end_user": {
"id": "<string>",
"email": "<string>",
"display_name": "<string>",
"tags": {},
"organization": {
"id": "<string>",
"display_name": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Requires an API key with one of:
environment:connections:read or environment:connections:read_credentials. Learn more about API key scopes.The response content depends on the API authentication type (e.g: OAuth 2, OAuth 1, API key, etc.).If you do not want to deal with collecting & injecting credentials in requests for multiple authentication types, use the Proxy.
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!
Authorizations
An Environment API key from your Nango environment, or an Account API key for account-level endpoints.
Path Parameters
The connection ID used to create the connection.
Query Parameters
The integration ID used to create the connection (aka Unique Key).
If true, Nango will attempt to refresh the access access token regardless of its expiration status (false by default).
If true, return the refresh token as part of the response (false by default).
Response
Successfully returned a connection
Show child attributes
Show child attributes
Connection tags (key/value strings). Keys are normalized to lowercase.
Show child attributes
Show child attributes
- OAuth1
- OAuth2
- Basic Auth
- Api Key
- GitHub App
- JWT
- OAuth2 Client
- App Store
- Unauthenticated
- Custom
- TBA
- Bill
- Two Step
- Signature
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?