Skip to main content
POST
/
sync
/
start
Start a sync
curl --request POST \
  --url https://api.nango.dev/sync/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_config_key": "<string>",
  "syncs": [
    "github-issues"
  ],
  "connection_id": "<string>"
}
'
{
  "success": true
}
Requires an API key with the environment:syncs:execute scope. Learn more about API key scopes.

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Body

application/json
​
provider_config_key
string
required

The ID of the integration that you established within Nango.

​
syncs
required

A list of sync names that you wish to start. If empty, all syncs are triggered

Sync name

​
connection_id
string

The ID of the connection. If omitted, the syncs will be started for all relevant connections.

Response

Successfully started the sync

​
success
boolean
required