Skip to main content
New to Corsair? See API access, authentication, and error handling.

Actions

trigger

actions.trigger Run a legacy action for a connection synchronously. Actions can write to the end customer’s account. Risk: destructive
Input Output: any

Connections

delete

connections.delete Delete a connection and its stored credentials. Risk: destructive · Irreversible
Input Output

get

connections.get Get one connection. Pass include_credentials: true to also return its live third-party credentials (access token, API key, password); they are dropped otherwise. Risk: read
Input Credentials are dropped unless include_credentials is true. Pass refresh_token: true as well to also get the refresh token. Output

import

connections.import Create a connection from credentials you already hold, or overwrite an existing connection’s credentials when connection_id matches. The credentials are not returned. Risk: destructive · Irreversible
Input
Output

list

connections.list List connections (no credentials), filtered by connection ID or tags, with page and limit. Risk: read
Input Output

patch

connections.patch Edit a connection: replace its tags or set a webhook URL override. Risk: write
Input
Output

setMetadata

connections.setMetadata Replace the whole metadata object of one or more connections; keys not passed are removed. Risk: destructive · Irreversible
Input Output

updateMetadata

connections.updateMetadata Merge keys into the metadata of one or more connections. Risk: write
Input Output

Environment

getVariables

environment.getVariables Get the environment variables set in the Nango dashboard, values in plain text (they often hold secrets). Risk: read
Input: empty object Output: object[]

Functions

delete

functions.delete Delete a deployed function, e.g. a catalog sync enabled in the dashboard; functions deployed from a repo with the nango CLI cannot be deleted here. Risk: destructive · Irreversible
Input Also pass the required type: action, sync, tool or function (e.g. type: "sync"). Output

get

functions.get Get one function of an integration, with its schema and deployment state. Risk: read
Input Output

getCode

functions.getCode Get a function’s TypeScript source code. Risk: read
Input Output

list

functions.list List an integration’s functions (syncs, tools, on-event functions), including Nango catalog tools. Risk: read
Input Output

Integrations

create

integrations.create Create an integration for a provider, optionally with developer app credentials or integration_config. Risk: write
Input
Output

delete

integrations.delete Delete an integration and every connection that uses it. Risk: destructive · Irreversible
Input Output

get

integrations.get Get an integration. include: [“credentials”] also returns the developer app client secret and private key. Risk: read
Input Output

list

integrations.list List the integrations configured in this environment. Risk: read
Input: empty object Output

update

integrations.update Edit an integration; fields left out keep their value. Risk: write
Input
Output

Providers

get

providers.get Get one provider’s auth mode, proxy settings and required connection fields. Risk: read
Input Output

list

providers.list List the APIs Nango supports; filter with search (the full list has over 1,000). Risk: read
Input Output

Proxy

delete

proxy.delete Send a DELETE through Nango’s proxy to the end customer’s API with the connection’s credentials. Risk: destructive · Irreversible
Input Output: any

get

proxy.get Send a GET through Nango’s proxy to the end customer’s API with the connection’s credentials. Risk: read
Input path is relative to the provider’s base URL. Headers in headers are sent on as Nango-Proxy-<name>. Output: any

patch

proxy.patch Send a PATCH through Nango’s proxy to the end customer’s API with the connection’s credentials. Risk: destructive
Input Output: any

post

proxy.post Send a POST through Nango’s proxy to the end customer’s API with the connection’s credentials. Risk: destructive
Input Output: any

put

proxy.put Send a PUT through Nango’s proxy to the end customer’s API with the connection’s credentials. Risk: destructive
Input Output: any

Records

list

records.list List the records a sync stored for a connection and model, paginated with next_cursor. Risk: read
Input Page with next_cursor until it is null; a page can hold fewer than limit records. Output

Scripts

getConfig

scripts.getConfig Get the configuration of every deployed function in the environment, in Nango or OpenAI tool format. Risk: read
Input format: "openai" returns the functions as OpenAI tool definitions. Output: Record<string, any>[] \| Record<string, any>

Sessions

create

sessions.create Create a Connect session; returns a short-lived token and a connect link an end user opens to authorize an integration. Risk: write
Input Either tags or end_user is required; Nango recommends tags. Give the returned connect_link to the end user.
Output

reconnect

sessions.reconnect Create a Connect session that re-authorizes an existing connection, keeping its connection ID. Risk: write
Input
Output

Syncs

pause

syncs.pause Pause the schedule of syncs for one connection or all. Risk: write
Input
Output

start

syncs.start Start the schedule of syncs for one connection or all; they run now and then on their frequency. Risk: write
Input
Output

status

syncs.status Get the status, schedule, last result and record counts of syncs. Risk: read
Input Output

trigger

syncs.trigger Run syncs once now, for one connection or all; reset starts from scratch. Risk: write
Input syncs takes names, or { name, variant } objects where variant is required (the default variant is base).
Output

updateFrequency

syncs.updateFrequency Override a sync’s frequency for one connection, or restore the default with null. Risk: write
Input Output

Tools

call

tools.call Call a deployed tool for a connection and return its output. Tools can write to the end customer’s account. Risk: destructive
Input Output: any