Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-222763184.3 KB
source-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.

post/source-connections/{source_connection_id}/run

Path parameters

source_connection_idstring uuid required

Unique identifier of the source connection to sync (UUID)

Example:550e8400-e29b-41d4-a716-446655440000

Unique identifier of the source connection to sync (UUID)

Query parameters

force_full_syncboolean

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

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

Response

Created sync job

idstring uuid required

Unique identifier of the sync job

source_connection_idstring uuid required

ID of the source connection this job belongs to

status'created' | 'pending' | 'running' | 'completed' | 'failed' | 'cancelling' | 'cancelled' required

Sync job status enum.

started_atstring date-time nullable

When the job started execution (ISO 8601)

completed_atstring date-time nullable

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

duration_secondsnumber nullable

Total execution time in seconds. Null if still running.

entities_insertedinteger

Number of new entities created during this sync

entities_updatedinteger

Number of existing entities updated during this sync

entities_deletedinteger

Number of entities removed during this sync

entities_failedinteger

Number of entities that failed to process

errorstring nullable

Error message if the job failed

error_detailsobject nullable

Additional error context for debugging

Example response

{
  "completed_at": "2024-03-15T12:05:32Z",
  "duration_seconds": 332.5,
  "entities_deleted": 3,
  "entities_failed": 0,
  "entities_inserted": 45,
  "entities_updated": 12,
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "source_connection_id": "550e8400-e29b-41d4-a716-446655440000",
  "started_at": "2024-03-15T12:00:00Z",
  "status": "COMPLETED"
}