Skip to navigation
API ReferenceSource Connections

List Sync Jobs

Retrieve the sync job history for a source connection.

Returns a list of sync jobs ordered by creation time (newest first). Each job includes status, timing information, and entity counts.

Job statuses:

  • PENDING: Job is queued, waiting for the worker to pick it up
  • RUNNING: Sync is actively pulling and processing data
  • COMPLETED: Sync finished successfully
  • FAILED: Sync encountered an unrecoverable error
  • CANCELLING: Cancellation has been requested. The worker is gracefully stopping the pipeline and cleaning up destination data.
  • CANCELLED: Sync was cancelled. The worker has fully stopped and destination data cleanup has been scheduled.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

source_connection_idstringRequiredformat: "uuid"

Unique identifier of the source connection (UUID)

Query parameters

limitintegerOptional1-1000Defaults to 100

Maximum number of jobs to return (1-1000)

Response

List of sync jobs
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 nullOptionalformat: "date-time"

When the job started execution (ISO 8601)

completed_atstring or nullOptionalformat: "date-time"

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

duration_secondsdouble or nullOptional
Total execution time in seconds. Null if still running.
entities_insertedintegerOptionalDefaults to 0
Number of new entities created during this sync
entities_updatedintegerOptionalDefaults to 0
Number of existing entities updated during this sync
entities_deletedintegerOptionalDefaults to 0
Number of entities removed during this sync
entities_failedintegerOptionalDefaults to 0
Number of entities that failed to process
errorstring or nullOptional
Error message if the job failed
error_categoryenum or nullOptional

Error category for credential errors (e.g. oauth_credentials_expired)

error_detailsmap from strings to any or nullOptional
Additional error context for debugging

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error