Skip to navigation
API ReferenceAI Task Builder

Get Batch Sync Status

View as MarkdownOpen in Claude

Returns the current status of a batch sync job created by POST /batches/{batch_id}/sync.

A sync job transitions through the following statuses:

  • queued — sync accepted, awaiting the background worker.
  • processing — the worker is materialising tasks.

Terminal statuses:

  • complete — the sync finished. tasks_created, datapoints_processed, groups_created, and groups_expanded are populated.
  • failed — the sync failed. reason is populated.

Continue polling while the status is queued or processing.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Path parameters

batch_idstringRequiredformat: "uuid"
The unique identifier of the batch
sync_idstringRequiredformat: "uuid"

The sync job ID returned by POST /batches/{batch_id}/sync

Response

Sync job status
batch_idstringformat: "uuid"
The batch this sync job belongs to.
dataset_idstringformat: "uuid"
The dataset whose appended datapoints are being synced.
sync_idstringformat: "uuid"
The unique identifier of the sync job.
created_atdatetime

When the sync job was created (ISO 8601, UTC).

updated_atdatetime

When the sync job was last updated (ISO 8601, UTC).

statusenum
Current status of the sync job.
Allowed values:
tasks_createdintegerOptional>=0

Number of tasks created this sync. Present when status is complete.

datapoints_processedintegerOptional>=0

Number of datapoints processed this sync. Present when status is complete.

groups_createdintegerOptional>=0

Number of new task groups created this sync. Present when status is complete.

groups_expandedintegerOptional>=0

Number of existing task groups grown this sync. Non-zero only for predetermined-grouping batches; always 0 for tasks-per-group batches. Present when status is complete.

reasonstringOptional

Human-readable reason for failure. Present when status is failed.

Errors

4XX
Client Request Error
404
Not Found Error