Get an integration
curl --request GET \
--url https://api.nango.dev/integrations/{uniqueKey} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nango.dev/integrations/{uniqueKey}"
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/integrations/{uniqueKey}', 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/integrations/{uniqueKey}",
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/integrations/{uniqueKey}"
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/integrations/{uniqueKey}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nango.dev/integrations/{uniqueKey}")
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{
"data": {
"unique_key": "slack-nango-community",
"display_name": "Slack",
"provider": "slack",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z"
}
}
{
"data": {
"unique_key": "github-nango",
"display_name": "GitHub",
"provider": "github",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": false,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "OAUTH2",
"client_id": "abc123",
"client_secret": "secret456",
"scopes": "repo,user",
"webhook_secret": null
}
}
}
{
"data": {
"unique_key": "github-app-nango",
"display_name": "GitHub App",
"provider": "github-app",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": false,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "CUSTOM",
"client_id": "abc123",
"client_secret": "secret456",
"app_id": "123456",
"app_link": "https://github.com/apps/my-app",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
}
}
}
{
"data": {
"unique_key": "mcp-generic",
"display_name": "MCP Server OAuth2 (Generic)",
"provider": "mcp-generic",
"logo": "http://localhost:3003/images/template-logos/mcp-generic.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "MCP_OAUTH2_GENERIC",
"client_name": "Acme Inc",
"client_uri": "https://acme.com",
"client_logo_uri": "https://acme.com/logo.png"
}
}
}
{
"data": {
"unique_key": "my-aws-integration",
"display_name": "AWS SigV4 Proxy",
"provider": "aws-sigv4",
"logo": "http://localhost:3003/images/template-logos/aws-sigv4.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "INTEGRATION_CONFIG",
"auth_mode": "AWS_SIGV4",
"integration_config": {
"service": "s3",
"stsMode": "builtin",
"awsAccessKeyId": "***",
"awsSecretAccessKey": "***"
}
}
}
}
Integrations
Get an integration
Returns a specific integration
GET
/
integrations
/
{uniqueKey}
Get an integration
curl --request GET \
--url https://api.nango.dev/integrations/{uniqueKey} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nango.dev/integrations/{uniqueKey}"
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/integrations/{uniqueKey}', 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/integrations/{uniqueKey}",
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/integrations/{uniqueKey}"
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/integrations/{uniqueKey}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nango.dev/integrations/{uniqueKey}")
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{
"data": {
"unique_key": "slack-nango-community",
"display_name": "Slack",
"provider": "slack",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z"
}
}
{
"data": {
"unique_key": "github-nango",
"display_name": "GitHub",
"provider": "github",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": false,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "OAUTH2",
"client_id": "abc123",
"client_secret": "secret456",
"scopes": "repo,user",
"webhook_secret": null
}
}
}
{
"data": {
"unique_key": "github-app-nango",
"display_name": "GitHub App",
"provider": "github-app",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": false,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "CUSTOM",
"client_id": "abc123",
"client_secret": "secret456",
"app_id": "123456",
"app_link": "https://github.com/apps/my-app",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
}
}
}
{
"data": {
"unique_key": "mcp-generic",
"display_name": "MCP Server OAuth2 (Generic)",
"provider": "mcp-generic",
"logo": "http://localhost:3003/images/template-logos/mcp-generic.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "MCP_OAUTH2_GENERIC",
"client_name": "Acme Inc",
"client_uri": "https://acme.com",
"client_logo_uri": "https://acme.com/logo.png"
}
}
}
{
"data": {
"unique_key": "my-aws-integration",
"display_name": "AWS SigV4 Proxy",
"provider": "aws-sigv4",
"logo": "http://localhost:3003/images/template-logos/aws-sigv4.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "INTEGRATION_CONFIG",
"auth_mode": "AWS_SIGV4",
"integration_config": {
"service": "s3",
"stsMode": "builtin",
"awsAccessKeyId": "***",
"awsSecretAccessKey": "***"
}
}
}
}
Requires an API key with one of:
environment:integrations:read or environment:integrations:read_credentials. Learn more about API key scopes.{
"data": {
"unique_key": "slack-nango-community",
"display_name": "Slack",
"provider": "slack",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z"
}
}
{
"data": {
"unique_key": "github-nango",
"display_name": "GitHub",
"provider": "github",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": false,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "OAUTH2",
"client_id": "abc123",
"client_secret": "secret456",
"scopes": "repo,user",
"webhook_secret": null
}
}
}
{
"data": {
"unique_key": "github-app-nango",
"display_name": "GitHub App",
"provider": "github-app",
"logo": "http://localhost:3003/images/template-logos/github.svg",
"forward_webhooks": false,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "CUSTOM",
"client_id": "abc123",
"client_secret": "secret456",
"app_id": "123456",
"app_link": "https://github.com/apps/my-app",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
}
}
}
{
"data": {
"unique_key": "mcp-generic",
"display_name": "MCP Server OAuth2 (Generic)",
"provider": "mcp-generic",
"logo": "http://localhost:3003/images/template-logos/mcp-generic.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "MCP_OAUTH2_GENERIC",
"client_name": "Acme Inc",
"client_uri": "https://acme.com",
"client_logo_uri": "https://acme.com/logo.png"
}
}
}
{
"data": {
"unique_key": "my-aws-integration",
"display_name": "AWS SigV4 Proxy",
"provider": "aws-sigv4",
"logo": "http://localhost:3003/images/template-logos/aws-sigv4.svg",
"forward_webhooks": true,
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
"credentials": {
"type": "INTEGRATION_CONFIG",
"auth_mode": "AWS_SIGV4",
"integration_config": {
"service": "s3",
"stsMode": "builtin",
"awsAccessKeyId": "***",
"awsSecretAccessKey": "***"
}
}
}
}
For providers that declare an
integration_config schema, alongside or instead of fixed credential fields (e.g. aws-sigv4, epic, private-api-generic), credentials returns type: "INTEGRATION_CONFIG" with the provider’s actual auth_mode and its integration_config values — only the fields that provider’s schema declares, nothing else from the integration’s internal storage. Any integration_config field the provider’s schema marks secret: true (e.g. aws-sigv4’s awsAccessKeyId and awsSecretAccessKey) is masked as *** rather than echoed in cleartext, regardless of API key scope.Authorizations
An Environment API key from your Nango environment, or an Account API key for account-level endpoints.
Path Parameters
The integration ID (unique_key) that you created in Nango.
Query Parameters
Include additional sensitive data
Available options:
webhook, credentials Response
Successfully returned an integration
Show child attributes
Show child attributes
Was this page helpful?