List Batches | Prolific API

curl -G https://api.prolific.com/api/v1/data-collection/batches \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d workspace_id=6278acb09062db3b35bcbeb0

{
  "results": [
    {
      "id": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "6278cb09062dbb35bc4abebc",
      "datasets": [
        {
          "id": "b7d9e8f0-1234-5678-9abc-def012345678",
          "total_datapoint_count": 1500,
          "filename": "user_responses_2024-01.csv"
        }
      ],
      "name": "Customer Feedback Batch January 2024",
      "status": "UNINITIALISED",
      "total_task_count": 25,
      "total_instruction_count": 5,
      "workspace_id": "6278acb09062db3b35bcbeb0",
      "schema_version": 1,
      "task_details": {
        "task_name": "Sentiment Analysis Task",
        "task_introduction": "<p>Welcome to the sentiment analysis task. Your goal is to classify customer feedback into positive, neutral, or negative categories.</p>",
        "task_steps": "<ol><li>Read each feedback entry carefully.</li><li>Select the sentiment category that best fits the feedback.</li><li>Submit your classification.</li></ol>"
      },
      "total_task_groups": 3
    }
  ],
  "meta": {
    "count": 1
  }
}

curl -G https://api.prolific.com/api/v1/data-collection/batches \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d workspace_id=6278acb09062db3b35bcbeb0

{
  "results": [
    {
      "id": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "6278cb09062dbb35bc4abebc",
      "datasets": [
        {
          "id": "b7d9e8f0-1234-5678-9abc-def012345678",
          "total_datapoint_count": 1500,
          "filename": "user_responses_2024-01.csv"
        }
      ],
      "name": "Customer Feedback Batch January 2024",
      "status": "UNINITIALISED",
      "total_task_count": 25,
      "total_instruction_count": 5,
      "workspace_id": "6278acb09062db3b35bcbeb0",
      "schema_version": 1,
      "task_details": {
        "task_name": "Sentiment Analysis Task",
        "task_introduction": "<p>Welcome to the sentiment analysis task. Your goal is to classify customer feedback into positive, neutral, or negative categories.</p>",
        "task_steps": "<ol><li>Read each feedback entry carefully.</li><li>Select the sentiment category that best fits the feedback.</li><li>Submit your classification.</li></ol>"
      },
      "total_task_groups": 3
    }
  ],
  "meta": {
    "count": 1
  }
}

Get all AI Task Builder batches by workspace id

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

Query parameters

workspace_idstringRequired

The unique identifier of the workspace

Response

resultslist of objects

metaobject

Errors

4XX

Client Request Error

$	curl -G https://api.prolific.com/api/v1/data-collection/batches \
>	-H "Authorization: Token <token>" \
>	-H "Content-Type: application/json" \
>	-d workspace_id=6278acb09062db3b35bcbeb0

1	{
2	"results": [
3	{
4	"id": "a3f1c2d4-5b6e-7f89-0123-456789abcdef",
5	"created_at": "2024-01-15T09:30:00Z",
6	"created_by": "6278cb09062dbb35bc4abebc",
7	"datasets": [
8	{
9	"id": "b7d9e8f0-1234-5678-9abc-def012345678",
10	"total_datapoint_count": 1500,
11	"filename": "user_responses_2024-01.csv"
12	}
13	],
14	"name": "Customer Feedback Batch January 2024",
15	"status": "UNINITIALISED",
16	"total_task_count": 25,
17	"total_instruction_count": 5,
18	"workspace_id": "6278acb09062db3b35bcbeb0",
19	"schema_version": 1,
20	"task_details": {
21	"task_name": "Sentiment Analysis Task",
22	"task_introduction": "<p>Welcome to the sentiment analysis task. Your goal is to classify customer feedback into positive, neutral, or negative categories.</p>",
23	"task_steps": "<ol><li>Read each feedback entry carefully.</li><li>Select the sentiment category that best fits the feedback.</li><li>Submit your classification.</li></ol>"
24	},
25	"total_task_groups": 3
26	}
27	],
28	"meta": {
29	"count": 1
30	}
31	}