> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/nango.md).

# Nango

Run Nango syncs and actions and manage Nango connections.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication      |
| --------- | ------------------- |
| Nango     | Environment API key |

#### Nango

Connect to Nango with an Environment API key to run syncs and actions.

**Set up in Nango**

1. Prepare the Nango account or service that the workflow will access. Grant access to the required resources and operations.
2. **Environment API key:** Create an Environment API key in Nango with the required environment scopes, then paste it here.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Nango**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field       | Required | What to enter                                                                                                                                                                         |
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Environment API key | Yes      | Create an Environment API key in Nango with the required environment scopes, then paste it here. [Provider instructions](https://nango.dev/docs/reference/backend/http-api/api-keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Nango** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Trigger Sync

Run one selected deployed sync now for a Nango connection.

**Required permissions:** `environment:syncs:execute`.

**Inputs**

| Field                | Type            | Required | Description                                                                             |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Integration          | select (string) | Yes      | The Nango integration whose sync should run. Options load from the selected connection. |
| Nango connection     | select (string) | Yes      | The connected account to sync. Options load from the selected connection.               |
| Sync                 | select (string) | Yes      | The deployed sync to run. Options load from the selected connection.                    |
| Reset sync state     | boolean         | No       | Clear the checkpoint and restart the sync from the beginning. Default: false.           |
| Empty cached records | boolean         | No       | Delete cached records before the reset sync runs. Default: false.                       |

**Outputs**

| Field     | Type    | Description                              |
| --------- | ------- | ---------------------------------------- |
| Triggered | boolean | Whether Nango accepted the sync trigger. |

#### Get Sync Records

Retrieve cached records produced by a Nango sync.

**Required permissions:** `environment:records:read`.

**Inputs**

| Field            | Type            | Required | Description                                                                                    |
| ---------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------- |
| Integration      | select (string) | Yes      | The Nango integration that produced the records. Options load from the selected connection.    |
| Nango connection | select (string) | Yes      | The connected account whose records should be read. Options load from the selected connection. |
| Model            | select (string) | Yes      | The deployed sync model to retrieve. Options load from the selected connection.                |
| Cursor           | string          | No       | Resume after a cursor returned by an earlier call.                                             |
| Maximum records  | integer         | No       | Maximum records to return in this action call. Minimum: 1. Default: 100.                       |
| Record IDs       | array           | No       | Record IDs to include.                                                                         |

**Outputs**

| Field       | Type          | Description                                            |
| ----------- | ------------- | ------------------------------------------------------ |
| Records     | object\_array | The synced records as data and Nango metadata objects. |
| Next cursor | string        | Opaque cursor for the next records call.               |

#### List Connections

Find Nango connections without exposing their credentials.

**Inputs**

| Field               | Type    | Required | Description                                                                           |
| ------------------- | ------- | -------- | ------------------------------------------------------------------------------------- |
| Search              | string  | No       | Partially match connection IDs or end-user profiles.                                  |
| Nango connection ID | string  | No       | Return only connections with this exact ID.                                           |
| Maximum connections | integer | No       | Maximum connections to return from this page. Minimum: 1. Maximum: 100. Default: 100. |
| Page                | integer | No       | Zero-based Nango result page to retrieve. Minimum: 0. Default: 0.                     |

**Outputs**

| Field       | Type          | Description                                                    |
| ----------- | ------------- | -------------------------------------------------------------- |
| Connections | object\_array | Connection metadata, integration IDs, tags, and health errors. |
| Next page   | integer       | Page number to use when more connections may be available.     |

#### Delete Connection

Remove a Nango connection and stop its scheduled syncs.

**Required permissions:** `environment:connections:delete`.

**Inputs**

| Field            | Type            | Required | Description                                                                          |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Integration      | select (string) | Yes      | The integration that owns the connection. Options load from the selected connection. |
| Nango connection | select (string) | Yes      | The connection to remove. Options load from the selected connection.                 |
| Confirm deletion | boolean         | Yes      | Confirm that this connection should become inaccessible immediately. Default: false. |

**Outputs**

| Field   | Type    | Description                                     |
| ------- | ------- | ----------------------------------------------- |
| Deleted | boolean | Whether Nango accepted the connection deletion. |

#### Trigger Action

Run a deployed Nango action for one connection.

**Required permissions:** `environment:actions:execute`.

**Inputs**

| Field            | Type            | Required | Description                                                                               |
| ---------------- | --------------- | -------- | ----------------------------------------------------------------------------------------- |
| Integration      | select (string) | Yes      | The Nango integration that defines the action. Options load from the selected connection. |
| Nango connection | select (string) | Yes      | The connected account to use for the action. Options load from the selected connection.   |
| Action name      | select (string) | Yes      | The exact deployed Nango action to run. Options load from the selected connection.        |
| Action input     | textarea        | No       | JSON object expected by the deployed action. Default: {}.                                 |

**Outputs**

| Field  | Type   | Description                                     |
| ------ | ------ | ----------------------------------------------- |
| Result | object | The JSON value returned by the deployed action. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/nango.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
