Actions
trigger
actions.trigger
Run a legacy action for a connection synchronously. Actions can write to the end customer’s account.
Risk: destructive
any
Connections
delete
connections.delete
Delete a connection and its stored credentials.
Risk: destructive · Irreversible
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
include_credentials is true. Pass refresh_token: true as well to also get the refresh token.
Output
errors full type
errors full type
end_user full type
end_user full type
credentials full type
credentials full type
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
credentials full type
credentials full type
end_user full type
end_user full type
errors full type
errors full type
end_user full type
end_user full type
credentials full type
credentials full type
list
connections.list
List connections (no credentials), filtered by connection ID or tags, with page and limit.
Risk: read
connections full type
connections full type
patch
connections.patch
Edit a connection: replace its tags or set a webhook URL override.
Risk: write
body full type
body full type
setMetadata
connections.setMetadata
Replace the whole metadata object of one or more connections; keys not passed are removed.
Risk: destructive · Irreversible
updateMetadata
connections.updateMetadata
Merge keys into the metadata of one or more connections.
Risk: write
Environment
getVariables
environment.getVariables
Get the environment variables set in the Nango dashboard, values in plain text (they often hold secrets).
Risk: read
object[]
Output full type
Output full type
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
type: action, sync, tool or function (e.g. type: "sync").
Output
data full type
data full type
get
functions.get
Get one function of an integration, with its schema and deployment state.
Risk: read
data full type
data full type
getCode
functions.getCode
Get a function’s TypeScript source code.
Risk: read
list
functions.list
List an integration’s functions (syncs, tools, on-event functions), including Nango catalog tools.
Risk: read
data full type
data full type
Integrations
create
integrations.create
Create an integration for a provider, optionally with developer app credentials or integration_config.
Risk: write
credentials full type
credentials full type
data full type
data full type
delete
integrations.delete
Delete an integration and every connection that uses it.
Risk: destructive · Irreversible
get
integrations.get
Get an integration. include: [“credentials”] also returns the developer app client secret and private key.
Risk: read
data full type
data full type
list
integrations.list
List the integrations configured in this environment.
Risk: read
data full type
data full type
update
integrations.update
Edit an integration; fields left out keep their value.
Risk: write
credentials full type
credentials full type
data full type
data full type
Providers
get
providers.get
Get one provider’s auth mode, proxy settings and required connection fields.
Risk: read
data full type
data full type
list
providers.list
List the APIs Nango supports; filter with search (the full list has over 1,000).
Risk: read
data full type
data full type
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
any
get
proxy.get
Send a GET through Nango’s proxy to the end customer’s API with the connection’s credentials.
Risk: read
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
any
post
proxy.post
Send a POST through Nango’s proxy to the end customer’s API with the connection’s credentials.
Risk: destructive
any
put
proxy.put
Send a PUT through Nango’s proxy to the end customer’s API with the connection’s credentials.
Risk: destructive
any
Records
list
records.list
List the records a sync stored for a connection and model, paginated with next_cursor.
Risk: read
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
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
tags or end_user is required; Nango recommends tags. Give the returned connect_link to the end user.
end_user full type
end_user full type
organization full type
organization full type
integrations_config_defaults full type
integrations_config_defaults full type
overrides full type
overrides full type
data full type
data full type
reconnect
sessions.reconnect
Create a Connect session that re-authorizes an existing connection, keeping its connection ID.
Risk: write
end_user full type
end_user full type
organization full type
organization full type
integrations_config_defaults full type
integrations_config_defaults full type
overrides full type
overrides full type
data full type
data full type
Syncs
pause
syncs.pause
Pause the schedule of syncs for one connection or all.
Risk: write
syncs full type
syncs full type
start
syncs.start
Start the schedule of syncs for one connection or all; they run now and then on their frequency.
Risk: write
syncs full type
syncs full type
status
syncs.status
Get the status, schedule, last result and record counts of syncs.
Risk: read
syncs full type
syncs full type
trigger
syncs.trigger
Run syncs once now, for one connection or all; reset starts from scratch.
Risk: write
syncs takes names, or { name, variant } objects where variant is required (the default variant is base).
syncs full type
syncs full type
opts full type
opts full type
updateFrequency
syncs.updateFrequency
Override a sync’s frequency for one connection, or restore the default with null.
Risk: write
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
any