> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# nango
> Nango Integration Platform
**Server path:** `/nango` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------- | ------------------------------- |
| [`nango_create_connect_session`](#nango_create_connect_session) | Create connect session |
| [`nango_create_integration`](#nango_create_integration) | Create an integration |
| [`nango_create_quickstart_integration`](#nango_create_quickstart_integration) | Create a quickstart integration |
| [`nango_create_sync_variant`](#nango_create_sync_variant) | Create sync variant |
| [`nango_delete_connect_session`](#nango_delete_connect_session) | Delete connect session |
| [`nango_delete_connection`](#nango_delete_connection) | Delete a connection |
| [`nango_delete_integration`](#nango_delete_integration) | Delete an integration |
| [`nango_delete_sync_variant`](#nango_delete_sync_variant) | Delete sync variant |
| [`nango_edit_connection`](#nango_edit_connection) | Edit a connection |
| [`nango_edit_connection_metadata`](#nango_edit_connection_metadata) | Edit connection metadata |
| [`nango_edit_integration`](#nango_edit_integration) | Edit an integration |
| [`nango_get_action_result`](#nango_get_action_result) | Get action result |
| [`nango_get_connect_session`](#nango_get_connect_session) | Get connect session |
| [`nango_get_connection`](#nango_get_connection) | Get a connection |
| [`nango_get_environment_variables`](#nango_get_environment_variables) | Get environment variables |
| [`nango_get_integration`](#nango_get_integration) | Get an integration |
| [`nango_get_provider`](#nango_get_provider) | Get a provider |
| [`nango_get_records`](#nango_get_records) | Get synced records |
| [`nango_get_scripts_config`](#nango_get_scripts_config) | Get scripts configuration |
| [`nango_get_sync_status`](#nango_get_sync_status) | Get sync status |
| [`nango_list_connections`](#nango_list_connections) | List connections |
| [`nango_list_integrations`](#nango_list_integrations) | List integrations |
| [`nango_list_providers`](#nango_list_providers) | List all providers |
| [`nango_pause_sync`](#nango_pause_sync) | Pause a sync |
| [`nango_prune_records`](#nango_prune_records) | Prune records |
| [`nango_reconnect_connect_session`](#nango_reconnect_connect_session) | Reconnect with connect session |
| [`nango_set_connection_metadata`](#nango_set_connection_metadata) | Set connection metadata |
| [`nango_start_sync`](#nango_start_sync) | Start a sync |
| [`nango_trigger_action`](#nango_trigger_action) | Trigger an action |
| [`nango_trigger_sync`](#nango_trigger_sync) | Trigger a sync |
| [`nango_update_sync_frequency`](#nango_update_sync_frequency) | Update sync frequency |
| [`nango_upsert_connection`](#nango_upsert_connection) | Upsert a connection |
***
## nango\_create\_connect\_session
Create connect session
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------- |
| `allowed_integrations` | string\[] | No | — | Filters which integrations the end user can interact with |
| `end_user` | object | No | — | Deprecated, use tags instead |
| `integrations_config_defaults` | object | No | — | Integrations Config Defaults |
| `organization` | object | No | — | Deprecated, use tags instead |
| `overrides` | object | No | — | The overrides value |
| `tags` | object | No | — | Connection tags (key/value strings). Keys are normalized to lowercase. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"allowed_integrations": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters which integrations the end user can interact with"
},
"end_user": {
"description": "Deprecated, use tags instead"
},
"integrations_config_defaults": {
"type": "object",
"description": "Integrations Config Defaults"
},
"organization": {
"type": "object",
"description": "Deprecated, use tags instead",
"properties": {
"id": {
"type": "string",
"description": "Uniquely identifies the organization the end user belongs to"
},
"display_name": {
"type": "string",
"description": "Display Name"
}
},
"required": [
"id"
]
},
"overrides": {
"type": "object",
"description": "The overrides value"
},
"tags": {
"type": "object",
"description": "Connection tags (key/value strings). Keys are normalized to lowercase."
}
},
"required": [
"PCID"
]
}
```
***
## nango\_create\_integration
Create an integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `credentials` | object | No | — | Integration credentials schema for different authentication types. |
| `display_name` | string | No | — | The integration display name. |
| `provider` | string | Yes | — | The provider unique name. |
| `unique_key` | string | Yes | — | A unique integration ID, which you will use in the other API calls to reference this integration. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"credentials": {
"description": "Integration credentials schema for different authentication types."
},
"display_name": {
"type": "string",
"description": "The integration display name."
},
"provider": {
"type": "string",
"description": "The provider unique name."
},
"unique_key": {
"type": "string",
"description": "A unique integration ID, which you will use in the other API calls to reference this integration."
}
},
"required": [
"PCID",
"provider",
"unique_key"
]
}
```
***
## nango\_create\_quickstart\_integration
Create a quickstart integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `display_name` | string | No | — | The integration display name. |
| `forward_webhooks` | boolean | No | — | Whether to forward webhooks for this integration. |
| `provider` | string | Yes | — | The provider unique name. |
| `unique_key` | string | Yes | — | A unique integration ID, which you will use in the other API calls to reference this integration. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"display_name": {
"type": "string",
"description": "The integration display name."
},
"forward_webhooks": {
"type": "boolean",
"description": "Whether to forward webhooks for this integration."
},
"provider": {
"type": "string",
"description": "The provider unique name."
},
"unique_key": {
"type": "string",
"description": "A unique integration ID, which you will use in the other API calls to reference this integration."
}
},
"required": [
"PCID",
"provider",
"unique_key"
]
}
```
***
## nango\_create\_sync\_variant
Create sync variant
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | --------------------------------------------------------------------- |
| `name` | string | Yes | — | The name of the sync |
| `variant` | string | Yes | — | The name of the variant to create. Cannot be "base" (protected name). |
| `connection_id` | string | Yes | — | The ID of the connection to create the sync variant for |
| `provider_config_key` | string | Yes | — | The integration ID used when creating the connection |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name of the sync"
},
"variant": {
"type": "string",
"description": "The name of the variant to create. Cannot be \"base\" (protected name)."
},
"connection_id": {
"type": "string",
"description": "The ID of the connection to create the sync variant for"
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used when creating the connection"
}
},
"required": [
"PCID",
"name",
"variant",
"connection_id",
"provider_config_key"
]
}
```
***
## nango\_delete\_connect\_session
Delete connect session
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## nango\_delete\_connection
Delete a connection
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------ |
| `connectionId` | string | Yes | — | The connection ID used to create the connection. |
| `provider_config_key` | string | Yes | — | The integration ID used to create the connection (aka Unique Key). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connectionId": {
"type": "string",
"description": "The connection ID used to create the connection."
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
}
},
"required": [
"PCID",
"connectionId",
"provider_config_key"
]
}
```
***
## nango\_delete\_integration
Delete an integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------------------------------------- |
| `uniqueKey` | string | Yes | — | The integration ID (unique\_key) that you created in Nango. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uniqueKey": {
"type": "string",
"description": "The integration ID (unique_key) that you created in Nango."
}
},
"required": [
"PCID",
"uniqueKey"
]
}
```
***
## nango\_delete\_sync\_variant
Delete sync variant
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | --------------------------------------------------------------------- |
| `name` | string | Yes | — | The name of the sync |
| `variant` | string | Yes | — | The name of the variant to delete. Cannot be "base" (protected name). |
| `connection_id` | string | Yes | — | The ID of the connection the sync variant belongs to |
| `provider_config_key` | string | Yes | — | The integration ID used when creating the connection |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name of the sync"
},
"variant": {
"type": "string",
"description": "The name of the variant to delete. Cannot be \"base\" (protected name)."
},
"connection_id": {
"type": "string",
"description": "The ID of the connection the sync variant belongs to"
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used when creating the connection"
}
},
"required": [
"PCID",
"name",
"variant",
"connection_id",
"provider_config_key"
]
}
```
***
## nango\_edit\_connection
Edit a connection
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- |
| `connectionId` | string | Yes | — | The connection ID used to create the connection. |
| `provider_config_key` | string | Yes | — | The integration ID used to create the connection (aka Unique Key). |
| `end_user` | object | No | — | Deprecated, use tags instead |
| `tags` | object | No | — | Connection tags (key/value strings). Keys are normalized to lowercase. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connectionId": {
"type": "string",
"description": "The connection ID used to create the connection."
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
},
"end_user": {
"description": "Deprecated, use tags instead"
},
"tags": {
"type": "object",
"description": "Connection tags (key/value strings). Keys are normalized to lowercase."
}
},
"required": [
"PCID",
"connectionId",
"provider_config_key"
]
}
```
***
## nango\_edit\_connection\_metadata
Edit connection metadata
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connection_id` | string\[] | No | — | The connection IDs used to update the metadata on. If one connection id is invalid in the array the entire operation is aborted with no changes made. |
| `metadata` | object | No | — | The metadata value |
| `provider_config_key` | string | No | — | The integration ID used to create the connection (aka Unique Key). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "The connection IDs used to update the metadata on. If one connection id is invalid in the array the entire operation is aborted with no changes made."
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
}
},
"required": [
"PCID"
]
}
```
***
## nango\_edit\_integration
Edit an integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `uniqueKey` | string | Yes | — | The integration ID (unique\_key) that you created in Nango. |
| `credentials` | object | No | — | Integration credentials schema for different authentication types. |
| `display_name` | string | No | — | The integration display name. |
| `unique_key` | string | No | — | A unique integration ID, which you will use in the other API calls to reference this integration. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uniqueKey": {
"type": "string",
"description": "The integration ID (unique_key) that you created in Nango."
},
"credentials": {
"description": "Integration credentials schema for different authentication types."
},
"display_name": {
"type": "string",
"description": "The integration display name."
},
"unique_key": {
"type": "string",
"description": "A unique integration ID, which you will use in the other API calls to reference this integration."
}
},
"required": [
"PCID",
"uniqueKey"
]
}
```
***
## nango\_get\_action\_result
Get action result
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `actionId` | string | Yes | — | The ID of the asynchronous action (returned from triggering an action with X-Async header) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actionId": {
"type": "string",
"description": "The ID of the asynchronous action (returned from triggering an action with X-Async header)"
}
},
"required": [
"PCID",
"actionId"
]
}
```
***
## nango\_get\_connect\_session
Get connect session
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## nango\_get\_connection
Get a connection
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |
| `connectionId` | string | Yes | — | The connection ID used to create the connection. |
| `provider_config_key` | string | Yes | — | The integration ID used to create the connection (aka Unique Key). |
| `force_refresh` | boolean | No | — | If true, Nango will attempt to refresh the access access token regardless of its expiration status (false by default). |
| `refresh_token` | boolean | No | — | If true, return the refresh token as part of the response (false by default). |
| `refresh_github_app_jwt_token` | boolean | No | — | If true, this will refresh the JWT token for GitHub App / Github App OAuth connections |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connectionId": {
"type": "string",
"description": "The connection ID used to create the connection."
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
},
"force_refresh": {
"type": "boolean",
"description": "If true, Nango will attempt to refresh the access access token regardless of its expiration status (false by default)."
},
"refresh_token": {
"type": "boolean",
"description": "If true, return the refresh token as part of the response (false by default)."
},
"refresh_github_app_jwt_token": {
"type": "boolean",
"description": "If true, this will refresh the JWT token for GitHub App / Github App OAuth connections"
}
},
"required": [
"PCID",
"connectionId",
"provider_config_key"
]
}
```
***
## nango\_get\_environment\_variables
Get environment variables
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## nango\_get\_integration
Get an integration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | --------- | -------- | ------- | ----------------------------------------------------------- |
| `uniqueKey` | string | Yes | — | The integration ID (unique\_key) that you created in Nango. |
| `include` | string\[] | No | — | Include additional sensitive data |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"uniqueKey": {
"type": "string",
"description": "The integration ID (unique_key) that you created in Nango."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"webhook",
"credentials"
]
},
"description": "Include additional sensitive data"
}
},
"required": [
"PCID",
"uniqueKey"
]
}
```
***
## nango\_get\_provider
Get a provider
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------------- |
| `provider` | string | Yes | — | The provider name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"provider": {
"type": "string",
"description": "The provider name"
}
},
"required": [
"PCID",
"provider"
]
}
```
***
## nango\_get\_records
Get synced records
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `model` | string | Yes | — | The data model to fetch |
| `cursor` | string | No | — | A marker used to fetch records modified after a specific point in time. If not provided, all records are returned. Each record includes a cursor value found in \_nango\_metadata.cursor. Save the cursor from the last record retrieved to track your sync progress. Use the cursor parameter together with the limit parameter to paginate through records. The cursor is more precise than modified\_after, as it can differentiate between records with the same modification timestamp. |
| `limit` | integer | No | — | The maximum number of records to return. Defaults to 100. |
| `filter` | string | No | — | Filter to only show results that have been added or updated or deleted. |
| `modified_after` | string | No | — | A timestamp (e.g., 2023-05-31T11:46:13.390Z) used to fetch records modified after this date and time. If not provided, all records are returned. The modified\_after parameter is less precise than cursor, as multiple records may share the same modification timestamp. |
| `delta` | string | No | — | DEPRECATED (use modified\_after) Timestamp, e.g. 2023-05-31T11:46:13.390Z. If passed, only records modified after this timestamp are returned, otherwise all records are returned. |
| `ids` | string\[] | No | — | An array of string containing a list of your records IDs. The list will be filtered to include only the records with a matching ID. |
| `variant` | string | No | — | The variant of the model to fetch |
| `connection_id` | string | Yes | — | The connection ID used to create the connection. |
| `provider_config_key` | string | Yes | — | The integration ID used to create the connection (aka Unique Key). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model": {
"type": "string",
"description": "The data model to fetch"
},
"cursor": {
"type": "string",
"description": "A marker used to fetch records modified after a specific point in time. If not provided, all records are returned. Each record includes a cursor value found in _nango_metadata.cursor. Save the cursor from the last record retrieved to track your sync progress. Use the cursor parameter together with the limit parameter to paginate through records. The cursor is more precise than modified_after, as it can differentiate between records with the same modification timestamp."
},
"limit": {
"type": "integer",
"description": "The maximum number of records to return. Defaults to 100."
},
"filter": {
"type": "string",
"description": "Filter to only show results that have been added or updated or deleted.",
"enum": [
"added",
"updated",
"deleted"
]
},
"modified_after": {
"type": "string",
"description": "A timestamp (e.g., 2023-05-31T11:46:13.390Z) used to fetch records modified after this date and time. If not provided, all records are returned. The modified_after parameter is less precise than cursor, as multiple records may share the same modification timestamp."
},
"delta": {
"type": "string",
"description": "DEPRECATED (use modified_after) Timestamp, e.g. 2023-05-31T11:46:13.390Z. If passed, only records modified after this timestamp are returned, otherwise all records are returned."
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of string containing a list of your records IDs. The list will be filtered to include only the records with a matching ID."
},
"variant": {
"type": "string",
"description": "The variant of the model to fetch"
},
"connection_id": {
"type": "string",
"description": "The connection ID used to create the connection."
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
}
},
"required": [
"PCID",
"model",
"connection_id",
"provider_config_key"
]
}
```
***
## nango\_get\_scripts\_config
Get scripts configuration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------- |
| `format` | string | No | — | The output type of the script configuration |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"format": {
"type": "string",
"description": "The output type of the script configuration",
"enum": [
"nango",
"openai"
]
}
},
"required": [
"PCID"
]
}
```
***
## nango\_get\_sync\_status
Get sync status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `provider_config_key` | string | Yes | — | The ID of the integration you established within Nango |
| `syncs` | string | Yes | — | The name of the syncs you want to fetch a status for, as a comma-separated list. Pass in "\*" to return all syncs for the integration. For variants, use the format "syncName::variantName". |
| `connection_id` | string | No | — | The ID of the connection. If omitted, all connections will be surfaced. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"provider_config_key": {
"type": "string",
"description": "The ID of the integration you established within Nango"
},
"syncs": {
"type": "string",
"description": "The name of the syncs you want to fetch a status for, as a comma-separated list. Pass in \"*\" to return all syncs for the integration. For variants, use the format \"syncName::variantName\"."
},
"connection_id": {
"type": "string",
"description": "The ID of the connection. If omitted, all connections will be surfaced."
}
},
"required": [
"PCID",
"provider_config_key",
"syncs"
]
}
```
***
## nango\_list\_connections
List connections
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `connectionId` | string | No | — | Will exactly match a given connectionId. Can return multiple connections with the same ID across integrations |
| `search` | string | No | — | Will partially match connection IDs or end user profiles. |
| `endUserId` | string | No | — | Deprecated. Prefer filtering connections by tag (e.g. `tags[end_user_id]=...`). |
| `endUserOrganizationId` | string | No | — | Deprecated. Prefer filtering connections by tag (e.g. `tags[organization_id]=...`). |
| `tags` | object | No | — | Filter the list of connections based on connection tags. All provided tags must match. |
| `limit` | integer | No | — | Limit the number of connections returned |
| `page` | integer | No | — | Page number for paginated results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connectionId": {
"type": "string",
"description": "Will exactly match a given connectionId. Can return multiple connections with the same ID across integrations"
},
"search": {
"type": "string",
"description": "Will partially match connection IDs or end user profiles."
},
"endUserId": {
"type": "string",
"description": "Deprecated. Prefer filtering connections by tag (e.g. `tags[end_user_id]=...`)."
},
"endUserOrganizationId": {
"type": "string",
"description": "Deprecated. Prefer filtering connections by tag (e.g. `tags[organization_id]=...`)."
},
"tags": {
"type": "object",
"description": "Filter the list of connections based on connection tags. All provided tags must match."
},
"limit": {
"type": "integer",
"description": "Limit the number of connections returned"
},
"page": {
"type": "integer",
"description": "Page number for paginated results"
}
},
"required": [
"PCID"
]
}
```
***
## nango\_list\_integrations
List integrations
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## nango\_list\_providers
List all providers
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## nango\_pause\_sync
Pause a sync
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `connection_id` | string | No | — | The ID of the connection. If omitted, the syncs will be paused for all relevant connections. |
| `provider_config_key` | string | Yes | — | The ID of the integration that you established within Nango. |
| `syncs` | object | Yes | — | The syncs value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "string",
"description": "The ID of the connection. If omitted, the syncs will be paused for all relevant connections."
},
"provider_config_key": {
"type": "string",
"description": "The ID of the integration that you established within Nango."
},
"syncs": {
"description": "The syncs value"
}
},
"required": [
"PCID",
"provider_config_key",
"syncs"
]
}
```
***
## nango\_prune\_records
Prune records
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `connection_id` | string | Yes | — | The connection ID used to create the connection. |
| `provider_config_key` | string | Yes | — | The integration ID used to create the connection (aka Unique Key). |
| `limit` | integer | No | — | The maximum number of records to prune in this request. Defaults to 1000. |
| `model` | string | No | — | The data model to prune records from |
| `until_cursor` | string | No | — | Prune all records up to and including this cursor. Use the cursor value from \_nango\_metadata.cursor of the record you want to prune up to. |
| `variant` | string | No | — | The variant of the model |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "string",
"description": "The connection ID used to create the connection."
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
},
"limit": {
"type": "integer",
"description": "The maximum number of records to prune in this request. Defaults to 1000."
},
"model": {
"type": "string",
"description": "The data model to prune records from"
},
"until_cursor": {
"type": "string",
"description": "Prune all records up to and including this cursor. Use the cursor value from _nango_metadata.cursor of the record you want to prune up to."
},
"variant": {
"type": "string",
"description": "The variant of the model"
}
},
"required": [
"PCID",
"connection_id",
"provider_config_key"
]
}
```
***
## nango\_reconnect\_connect\_session
Reconnect with connect session
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | ------ | -------- | ------- | ---------------------------------------------------------------------- |
| `connection_id` | string | Yes | — | Connection Id |
| `end_user` | object | No | — | Deprecated, use tags instead |
| `integration_id` | string | Yes | — | Integration Id |
| `integrations_config_defaults` | object | No | — | Integrations Config Defaults |
| `organization` | object | No | — | Deprecated, use tags instead |
| `overrides` | object | No | — | The overrides value |
| `tags` | object | No | — | Connection tags (key/value strings). Keys are normalized to lowercase. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "string",
"description": "Connection Id"
},
"end_user": {
"description": "Deprecated, use tags instead"
},
"integration_id": {
"type": "string",
"description": "Integration Id"
},
"integrations_config_defaults": {
"type": "object",
"description": "Integrations Config Defaults"
},
"organization": {
"type": "object",
"description": "Deprecated, use tags instead",
"properties": {
"id": {
"type": "string",
"description": "Uniquely identifies the organization the end user belongs to"
},
"display_name": {
"type": "string",
"description": "Display Name"
}
},
"required": [
"id"
]
},
"overrides": {
"type": "object",
"description": "The overrides value"
},
"tags": {
"type": "object",
"description": "Connection tags (key/value strings). Keys are normalized to lowercase."
}
},
"required": [
"PCID",
"connection_id",
"integration_id"
]
}
```
***
## nango\_set\_connection\_metadata
Set connection metadata
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connection_id` | string\[] | Yes | — | The connection IDs used to set the metadata on. If one connection id is invalid in the array the entire operation is aborted with no changes made. |
| `metadata` | object | Yes | — | The metadata value |
| `provider_config_key` | string | Yes | — | The integration ID used to create the connection (aka Unique Key). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "The connection IDs used to set the metadata on. If one connection id is invalid in the array the entire operation is aborted with no changes made."
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
}
},
"required": [
"PCID",
"connection_id",
"metadata",
"provider_config_key"
]
}
```
***
## nango\_start\_sync
Start a sync
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------- |
| `connection_id` | string | No | — | The ID of the connection. If omitted, the syncs will be started for all relevant connections. |
| `provider_config_key` | string | Yes | — | The ID of the integration that you established within Nango. |
| `syncs` | object | Yes | — | The syncs value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "string",
"description": "The ID of the connection. If omitted, the syncs will be started for all relevant connections."
},
"provider_config_key": {
"type": "string",
"description": "The ID of the integration that you established within Nango."
},
"syncs": {
"description": "The syncs value"
}
},
"required": [
"PCID",
"provider_config_key",
"syncs"
]
}
```
***
## nango\_trigger\_action
Trigger an action
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connection_id` | string | Yes | — | The connection ID used to create the connection. |
| `provider_config_key` | string | Yes | — | The integration ID used to create the connection (aka Unique Key). |
| `x_async` | boolean | No | — | Set to true to trigger the action asynchronously. When true, the response will include a status URL and ID for retrieving the action result later. See Asynchronous action documentation for more details. |
| `x_max_retries` | integer | No | — | The maximum number of retries in case of failure (between 0 and 5). Only applicable when X-Async is true. Default to 0 if not specified. |
| `action_name` | string | Yes | — | The name of the action to trigger. |
| `input` | object | No | — | The necessary input for your action's 'exec' function. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "string",
"description": "The connection ID used to create the connection."
},
"provider_config_key": {
"type": "string",
"description": "The integration ID used to create the connection (aka Unique Key)."
},
"x_async": {
"type": "boolean",
"description": "Set to true to trigger the action asynchronously. When true, the response will include a status URL and ID for retrieving the action result later. See [Asynchronous action documentation](/guides/actions/use-an-action#asynchronous-action) for more details."
},
"x_max_retries": {
"type": "integer",
"description": "The maximum number of retries in case of failure (between 0 and 5). Only applicable when X-Async is true. Default to 0 if not specified."
},
"action_name": {
"type": "string",
"description": "The name of the action to trigger."
},
"input": {
"type": "object",
"description": "The necessary input for your action's 'exec' function."
}
},
"required": [
"PCID",
"connection_id",
"provider_config_key",
"action_name"
]
}
```
***
## nango\_trigger\_sync
Trigger a sync
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------- |
| `connection_id` | string | No | — | The ID of the connection. If omitted, the syncs will be triggered for all relevant connections. |
| `opts` | object | No | — | Options for triggering the sync. |
| `provider_config_key` | string | Yes | — | The ID of the integration that you established within Nango. |
| `syncs` | object | Yes | — | The syncs value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "string",
"description": "The ID of the connection. If omitted, the syncs will be triggered for all relevant connections."
},
"opts": {
"type": "object",
"description": "Options for triggering the sync.",
"properties": {
"reset": {
"type": "boolean",
"description": "If true, clears the checkpoint and lastSyncDate before triggering the sync, causing it to start fresh."
},
"emptyCache": {
"type": "boolean",
"description": "If true, deletes all cached records associated with the sync before triggering. Must be used with reset=true."
}
}
},
"provider_config_key": {
"type": "string",
"description": "The ID of the integration that you established within Nango."
},
"syncs": {
"description": "The syncs value"
}
},
"required": [
"PCID",
"provider_config_key",
"syncs"
]
}
```
***
## nango\_update\_sync\_frequency
Update sync frequency
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------------------- | ------ | -------- | ------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connection_id` | string | No | — | The ID of the connection | |
| `frequency` | string | null | Yes | — | The frequency you want to set (ex: 'every hour'). Set null to revert to the default frequency. Uses the [https://github.com/vercel/ms](https://github.com/vercel/ms) notations. Min frequency: 30 seconds. |
| `provider_config_key` | string | Yes | — | The ID of the integration you established within Nango | |
| `sync_name` | string | Yes | — | The name of the sync you want to update | |
| `sync_variant` | string | No | — | The variant of the sync you want to update | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_id": {
"type": "string",
"description": "The ID of the connection"
},
"frequency": {
"type": [
"string",
"null"
],
"description": "The frequency you want to set (ex: 'every hour'). Set null to revert to the default frequency. Uses the https://github.com/vercel/ms notations. Min frequency: 30 seconds."
},
"provider_config_key": {
"type": "string",
"description": "The ID of the integration you established within Nango"
},
"sync_name": {
"type": "string",
"description": "The name of the sync you want to update"
},
"sync_variant": {
"type": "string",
"description": "The variant of the sync you want to update"
}
},
"required": [
"PCID",
"frequency",
"provider_config_key",
"sync_name"
]
}
```
***
## nango\_upsert\_connection
Upsert a connection
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `connection_config` | object | No | — | (OAuth, required for some APIs) Additional configuration to be attached to the connection. |
| `connection_id` | string | No | — | The connection ID used to create the connection. |
| `credentials` | object | Yes | — | The credentials to be attached to the connection. |
| `end_user` | object | No | — | Deprecated, use tags instead |
| `metadata` | object | No | — | (OAuth, required for some APIs) Metadata to be attached to the connection. |
| `provider_config_key` | string | Yes | — | The integration ID that you created on Nango. |
| `tags` | object | No | — | Connection tags (key/value strings). Keys are normalized to lowercase. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"connection_config": {
"type": "object",
"description": "(OAuth, required for some APIs) Additional configuration to be attached to the connection."
},
"connection_id": {
"type": "string",
"description": "The connection ID used to create the connection."
},
"credentials": {
"type": "object",
"description": "The credentials to be attached to the connection."
},
"end_user": {
"description": "Deprecated, use tags instead"
},
"metadata": {
"type": "object",
"description": "(OAuth, required for some APIs) Metadata to be attached to the connection."
},
"provider_config_key": {
"type": "string",
"description": "The integration ID that you created on Nango."
},
"tags": {
"type": "object",
"description": "Connection tags (key/value strings). Keys are normalized to lowercase."
}
},
"required": [
"PCID",
"credentials",
"provider_config_key"
]
}
```