Get Batch Responses | Prolific API

import requests
url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id/responses"
headers = {"Authorization": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "results": [
    {
      "id": "a3f47b2e-9c4d-4f1a-8b2e-7d9f3c1a2b4e",
      "created_at": "2024-01-15T09:30:00Z",
      "batch_id": "batch_20240115_001",
      "participant_id": "participant_789",
      "response": {
        "instruction_id": "instr_101",
        "type": "multiple_choice",
        "answer": [
          {
            "value": "option_b"
          }
        ]
      },
      "task_id": "task_20240115_01",
      "submission_id": "submission_456",
      "correlation_id": "corr_1234567890",
      "metadata": {
        "device": "mobile",
        "location": "New York, USA"
      },
      "schema_version": 1,
      "no_submission": false
    }
  ],
  "meta": {
    "count": 1
  }
}

Get responses for an AI Task Builder batch as JSON. Returns individual response records for programmatic processing.

Authentication

Authorizationstring

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>.

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

Response

resultslist of objects or null

metaobject or null

Authentication

Path parameters

Response

Errors