API ReferenceSource Connections

Run Sync

Trigger a data synchronization job for a source connection.

Starts an asynchronous sync job that pulls the latest data from the connected source. The job runs in the background and you can monitor its progress using the jobs endpoint.

For continuous sync connections, this performs an incremental sync by default. Use force_full_sync=true to perform a complete re-sync of all data.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

source_connection_idstringRequiredformat: "uuid"

Unique identifier of the source connection to sync (UUID)

Query parameters

force_full_syncbooleanOptionalDefaults to false

Force a full sync ignoring cursor data. Only applies to continuous sync connections. Non-continuous connections always perform full syncs.

Response

Created sync job
idstringformat: "uuid"
Unique identifier of the sync job
source_connection_idstringformat: "uuid"
ID of the source connection this job belongs to
statusenum

Current status: PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, or CANCELLING

started_atstring or nullformat: "date-time"

When the job started execution (ISO 8601)

completed_atstring or nullformat: "date-time"

When the job finished (ISO 8601). Null if still running.

duration_secondsdouble or null
Total execution time in seconds. Null if still running.
entities_insertedinteger or nullDefaults to 0
Number of new entities created during this sync
entities_updatedinteger or nullDefaults to 0
Number of existing entities updated during this sync
entities_deletedinteger or nullDefaults to 0
Number of entities removed during this sync
entities_failedinteger or nullDefaults to 0
Number of entities that failed to process
errorstring or null
Error message if the job failed
error_detailsmap from strings to any or null
Additional error context for debugging

Errors