Nango

Permanently delete an end-user connection and the third-party credential Nango holds for it. Syncs for that connection stop and its records are removed; the end user must re-authorise to restore it.

Permanently delete an integration and every connection that belongs to it. The end users behind those connections will have to re-authorise.

Delete one deployed function from an integration. A function that was deployed by the Nango CLI cannot be deleted here -- the API answers `function_managed_by_deploy`.

End an agent session immediately, revoking its session token and MCP URL. Anything the agent was mid-way through stops having access.

Fetch the result of an action that was triggered with run_async. Poll this with the id trigger_action returned until the action has finished.

List the end-user connections in this Nango environment, optionally filtered by connection id, integration, end user or free text. Returns each connection's id, integration, provider, end user, tags and any active errors -- never the stored third-party credential.

Fetch the result of a function invocation by its id, for invocations that were queued rather than awaited.

List the integrations configured in this Nango environment -- the customer's own connected apps, each with its unique_key, provider, display name, logo and webhook-forwarding setting.

Fetch one integration by its unique key: provider, display name, webhook-forwarding setting, and which credential and connection-config fields are already set at the integration level (names only, never values).

List the sync, action and on-event functions deployed for one integration, paged and filterable by type or name.

Fetch one deployed function's definition: its type, trigger, models, frequency and input/output schemas.

Return the TypeScript source of one deployed function. Useful for reviewing or debugging what a sync actually fetches.

List every API provider Nango can integrate with (1000+), with each provider's auth mode, categories, proxy base URL and default scopes. This is Nango's catalogue, not the customer's own integrations -- use nango_get_integrations for those. Requires no key scope.

Fetch one provider's full configuration from Nango's catalogue: auth mode, authorization and token URLs, proxy base URL, available and default scopes, and any connection-configuration fields its integrations require. Requires no key scope.

List the pre-built sync and action function templates Nango publishes for one provider, with each template's name, description, required scopes and input/output schema. Requires no key scope.

Issue a GET against the third-party API behind one of the customer's connections, with Nango attaching (and refreshing) the stored credential server-side. The credential is never returned to the caller. Reads only -- the proxy's write verbs are not exposed. What a GET does is the destination API's business, though: a few APIs mutate on GET.

Read the records one sync has written for a connection, as a cursor-paged list. This is how synced third-party data is consumed: filter by change type or modification time to fetch only what moved since the last read.

Return every sync and action function deployed in this environment, with their models, schedules and input/output schemas -- the whole integration surface in one read. `format=openai` returns the actions as OpenAI function definitions.

Report the status of one or more syncs for a connection: schedule state, last run result, next run times and record counts. The first place to look when data is stale.

Update a connection's end-user record, tags, or webhook URL override. Does not touch the stored credential.

MERGE keys into the metadata stored on one or more connections, leaving keys you do not mention untouched. Use set_connection_metadata to replace the whole object.

Rename an integration, change its display name, or change whether it forwards webhooks. Credentials are not accepted here -- change them in the Nango dashboard.

Permanently delete synced records for a connection up to a cursor. Used to reclaim storage on a model that has grown; the records are gone and only a full re-sync brings them back.

Run one of the integration's action functions against a connection and return its result -- the write path for a Nango integration (create a contact, send a message). Set run_async to queue it and poll get_action_result instead of waiting.

Mint a short-lived Connect session for one end user and return a `connect_link` they can open to authorise an integration. This is the supported way to create a connection: the end user's own credential is entered in Nango's hosted UI and never passes through this tool.

Mint a Connect session that re-authorises an EXISTING connection whose credential has expired or been revoked, and return the link for the end user to open. Keeps the connection's id, syncs and records.

REPLACE the metadata stored on one or more connections. Metadata is the arbitrary JSON a sync or action function reads at runtime (the field list to fetch, a cursor, a customer-specific setting). This overwrites whatever was there -- use update_connection_metadata to merge.

Invoke an already-deployed function by name against a connection and return its result. The newer, general form of trigger_action -- it takes a function name and input, never source code.

Create a new integration in this Nango environment for one of the providers in Nango's catalogue. Credentials for the integration are NOT accepted here -- set the OAuth client id/secret in the Nango dashboard.

Create an integration pre-wired with Nango's own shared OAuth credentials for the provider, so it can be connected without registering a developer app first. Intended for evaluation; use create_integration plus the dashboard for production credentials.

Create a Nango agent session and return its MCP URL and session token, scoped to a chosen set of the customer's connections and tools. This is how an AI agent is given time-boxed, toolset-limited access to the third-party APIs Nango holds credentials for.

Pause the schedule of one or more syncs. Existing records stay; no new runs happen until start_sync resumes them.

Resume the SCHEDULE of one or more paused syncs, so they run on their frequency again. Use trigger_sync for a single run now.

Run one or more syncs now, outside their schedule. By default the run is incremental; `opts.reset` re-fetches everything from scratch.

Override how often one sync runs for one connection, or clear the override by passing a null frequency to fall back to the sync's own schedule.