Get a Batch

GET

https://api.prolific.com/api/v1/data-collection/batches/:batch_id

GET

/api/v1/data-collection/batches/:batch_id

curl https://api.prolific.com/api/v1/data-collection/batches/batch_id \
     -H "Authorization: Token <token>"

{
  "id": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "6278cb09062dbb35bc4abebc",
  "datasets": [
    {
      "id": "string",
      "total_datapoint_count": 1,
      "filename": "string"
    }
  ],
  "name": "Data Collection Batch",
  "status": "UNINITIALISED",
  "total_task_count": 1,
  "total_instruction_count": 1,
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "schema_version": 1,
  "task_details": {
    "task_name": "string",
    "task_introduction": "string",
    "task_steps": "string"
  },
  "total_task_groups": 1,
  "batch_items": [
    {
      "rows": [
        {
          "columns": [
            {
              "items": [
                {
                  "type": "dataset_field",
                  "field": "string"
                }
              ],
              "id": "string"
            }
          ],
          "id": "string"
        }
      ],
      "id": "string",
      "display_position": "intro"
    }
  ],
  "auto_sync_enabled": true
}

Get a specific AI Task Builder batch by its unique identifier.

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_idstringRequired

The unique identifier of the AI Task Builder batch

Response

idstringformat: "uuid"

created_atdatetime

An ISO-8601 formatted string representing the batch creation time, in UTC.

created_bystring

User ID of the Prolific user that created the resource.

datasetslist of objects

namestring

statusenum

Allowed values:

total_task_countinteger>=0

total_instruction_countinteger>=0

workspace_idstring

schema_versioninteger

task_detailsobject

total_task_groupsinteger>=0

batch_itemslist of objects or nullOptional

The persisted batch_items layout, populated when the batch was created with batch_items. null for legacy batches authored via the standalone instructions endpoint. Every page, row, column, and item carries a server-assigned id.

auto_sync_enabledbooleanOptional

When true, datapoints appended to the batch’s attached dataset automatically trigger a sync that materialises tasks for them. Optional — absent on batches that have never enabled auto-sync. Absent or false mean auto-sync is off.

Errors

4XX

Client Request Error