Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nango.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Using a coding agent? Set up the docs MCP and skills, then copy this page as prompt.
This quickstart uses the GitHub API as an example, but you can choose any of the 700+ APIs.
1

Create an integration

Sign up for free. This quickstart uses GitHub (User OAuth), which is pre-created with integration ID github-getting-started.If you want to test another API, go to the Integrations tab > Set up new integration > pick an API.
Signup cannot be automated. Ask the user to create a free Nango account in the UI first if they have not already done so, then ask for their Nango API key from the Environment settings tab > API Keys.Use the API key as Authorization: Bearer <NANGO-API-KEY>. The default API key created on signup has full access and is the simplest option. If the user creates a scoped API key instead, this quickstart needs environment:connect_sessions:write and environment:actions:execute. Add environment:connections:list if you confirm authorization through the API.For GitHub, use the pre-created integration ID github-getting-started; no integration creation or OAuth developer app setup is needed.If the user wants another API, ask them to create the integration in the Nango dashboard. You can list providers first and use the matching name to help them pick the right API:
curl --request GET \
  --url https://api.nango.dev/providers \
  --header 'Authorization: Bearer <NANGO-API-KEY>'
For OAuth APIs, walk the user through registering an OAuth developer app on the provider’s portal, then ask them to paste the Client ID, Client Secret, and required scopes into the Nango integration settings. If the dashboard offers Nango-provided developer app credentials, they can use that option for testing. This OAuth setup can be ignored when using the GitHub example.For provider details and response shapes, see the List all providers API.
2

Authorize the API

Go to the Connections tab > Add Test Connection > pick your integration, and complete the auth flow. For the GitHub example, pick github-getting-started.Copy the connection ID and your Nango API key from the Environment settings tab > API Keys. For the GitHub example, the integration ID is github-getting-started. You will use these values in the next steps.
To create a browser auth link programmatically, call:
curl --request POST \
  --url https://api.nango.dev/connect/sessions \
  --header 'Authorization: Bearer <NANGO-API-KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "tags": { "end_user_id": "quickstart-user" },
    "allowed_integrations": ["github-getting-started"]
  }'
Send the returned connect_link to the user. Once they complete authorization, confirm the connection in the dashboard or with the List connections API.
3

Enable a template function

Open your integration and enable a template function. For GitHub, enable the get-repository template.This is a Nango Function: it runs provider-specific code with the connected account’s credentials, without exposing those credentials to your app or agent.
Enabling template functions is only available in the Nango dashboard at the moment, and will be accessible via API soon.Ask the user to go to the Nango dashboard > Integrations tab > open the integration > Functions sub-tab, then deploy the template function they want to test. For this example, deploy get-repository.
4

Call the function

Trigger the function from your backend:
Install the SDK with npm i @nangohq/node, then run:
import { Nango } from '@nangohq/node';

const nango = new Nango({ secretKey: process.env.NANGO_API_KEY! });

const result = await nango.triggerAction(
    'github-getting-started',
    '<CONNECTION-ID>',
    'get-repository',
    {
        owner: 'NangoHQ',
        repo: 'nango'
    }
);

console.log(result);
You should receive GitHub repository details such as the repository ID, full name, visibility, default branch, and owner.
5

Inspect the run

Open the Logs tab to inspect the function execution, provider request, response, and any errors.🎉 You connected an API and ran your first integration function.
6

Next steps

Embed auth in your app

Let users connect external APIs from your product.

Build custom functions

Generate, test, customize, and deploy integration code.

Sync external data

Keep external API data fresh for your product or RAG pipeline.

Expose tools to agents

Use action functions through tool calling and MCP.
Questions, problems, feedback? Please reach out in the Slack community.