Quickstart - Nango Docs

AI-assisted quickstart

Copy this prompt into Claude, Cursor, or another coding agent to get guided through signup, API key setup, connection authorization, and your first function call.

For skills, the docs MCP server, and other agent setup options, see Coding agent setup.

Manual quickstart

The steps below show the flow end to end. This quickstart uses the GitHub API as an example, but you can choose any of the 800+ APIs.

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.

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.

Enable an integration function

The fastest way to enable a function is to use a template.Go to the Integrations tab > open the github-getting-started integration > Functions sub-tab. In the functions table, turn on the toggle in the Enable column for get-repository.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.

You can also build a custom function in your codebase, or use the Functions API to let an agent turn text-defined behavior into deployed function code.

Call the function

Trigger the function from your backend:

Node
cURL

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);

curl --request POST \
  --url https://api.nango.dev/action/trigger \
  --header 'Authorization: Bearer <NANGO-API-KEY>' \
  --header 'Connection-Id: <CONNECTION-ID>' \
  --header 'Provider-Config-Key: github-getting-started' \
  --header 'Content-Type: application/json' \
  --data '{
    "action_name": "get-repository",
    "input": {
      "owner": "NangoHQ",
      "repo": "nango"
    }
  }'

You should receive GitHub repository details such as the repository ID, full name, visibility, default branch, and owner.

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.

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.

​AI-assisted quickstart

​Manual quickstart

Embed auth in your app

Build custom functions

Sync external data

Expose tools to agents

AI-assisted quickstart

Manual quickstart