v4
OpenAPI 3.1.02026-07-31121440441.0 KBaiTaskBuilder
Get Batch Sync Status
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.
get/api/v1/data-collection/batches/{batch_id}/syncs/{sync_id}
Path parameters
batch_idstring uuid required
The unique identifier of the batch
sync_idstring uuid required
The sync job ID returned by POST /batches/{batch_id}/sync
Headers
Authorizationstring required
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>.
Response
Sync job status