Nango Docs home page

nangoHQ/nango
Sign Up
nangoHQ/nango

Syncs

Sync status

Reference

Overview

Use Integrations - Reference

Frontend SDK
HTTP API
- Authentication
- Rate limits
- Providers
- Integrations
- Connections
- Scripts
- Syncs
- Actions
- Proxy
- Connect
Backend SDKs
Resource limits

Build Integrations - Reference

CLI
API config (providers.yaml)
Integration scripts
Integration config (nango.yaml)

Syncs

Sync status

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

GET

sync

status

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

provider_config_key

string

provider_config_key

Required

string

The ID of the integration you established within Nango

syncs

string

syncs

Required

string

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

connection_id

string

connection_id

string

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

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[]

syncs.id

string

The unique identifier for the sync.

syncs.name

string

The name of the sync.

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

syncs.finishedAt

string

ISO string of the most recently completed sync

syncs.nextScheduledSyncAt

string

ISO string of the next scheduled sync time

syncs.frequency

string

The execution frequency of 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.recordCount

object

Total count of records for each model synced by the sync

Was this page helpful?

Pause sync(s)Override sync connection frequency

twitter linkedin github slack website