Sync status

Get the status of specified sync(s) (for a given connection or all applicable connections if no connection is specified)

Query Parameters

provider_config_key

string

required

The ID of the integration you established within Nango

syncs

string

required

The name of the syncs you want to fetch a status for. Pass in "*" to return all syncs per the integration

connection_id

string

The ID of the connection. If omitted, all connections will be surfaced.

Response

200 - application/json

syncs

object[]

Show child attributes

syncs.finishedAt

string

ISO string of the most recently completed sync

syncs.frequency

string

The execution frequency of the sync

syncs.id

string

The unique identifier for the sync.

syncs.latestResult

object

Additional information regarding the latest result of the sync. Contains a model name with added, updated and deleted records

syncs.name

string

The name of the sync.

syncs.nextScheduledSyncAt

string

ISO string of the next scheduled sync time

syncs.status

enum<string>

The current status of the sync.

Available options:

RUNNING,

PAUSED,

STOPPED,

SUCCESS,

ERROR

syncs.type

enum<string>

The most recent sync type completed

Available options:

INCREMENTAL,

INITIAL