For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
    • Introduction
    • Users
    • Taskflow
    • AI Task Builder
      • Batches
      • Exporting Batch Data
      • Collections
      • Exporting Collection Data
      • Datasets
      • Instructions
      • GETList Batches
      • POSTCreate a Batch
      • GETGet a Batch
      • PATCHUpdate a Batch
      • GETGet Batch Status
      • POSTSetup a Batch
      • GETGet Batch Responses
      • GETGet Batch Report
      • POSTDuplicate a Batch
      • POSTRequest a Batch Export
      • GETGet Batch Export Status
      • POSTCreate a Dataset
      • GETGet Dataset Upload URL
      • GETGet Dataset Status
      • GETGet Batch Instructions
      • POSTCreate Batch Instructions
      • PUTUpdate Batch Instructions
      • GETList Collections
      • POSTCreate a Collection
      • GETGet a Collection
      • PUTUpdate a Collection
      • GETGet Collection Responses
      • POSTRequest a Collection Export
      • GETGet Collection Export Status
    • Studies
    • Representative sample studies
    • study-collections
    • Filter Sets
    • Participant Groups
    • Custom Groups
    • Study Distribution
    • Submissions
    • Bonuses
    • Messages
    • Workspaces
    • Projects
    • Surveys
    • Webhooks
    • Invitations
    • Reward Recommendations
    • Testing
    • Well Known Endpoints
Go to app
LogoLogo
API ReferenceAI Task Builder

Get a Collection

|View as Markdown|Open in Claude|
GET
https://api.prolific.com/api/v1/data-collection/collections/:collection_id
GET
/api/v1/data-collection/collections/:collection_id
$curl https://api.prolific.com/api/v1/data-collection/collections/collection_id \
>     -H "Authorization: Token <token>" \
>     -H "Content-Type: application/json"
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "schema_version": 1,
4  "created_at": "2024-01-15T09:30:00Z",
5  "created_by": "user_987654321",
6  "workspace_id": "workspace_123456789",
7  "name": "Customer Feedback Survey",
8  "task_details": {
9    "task_name": "Product Satisfaction Survey",
10    "task_introduction": "<p>Welcome to our product satisfaction survey. Your feedback is valuable to us.</p>",
11    "task_steps": "<ol><li>Answer all questions honestly.</li><li>Submit your responses at the end.</li></ol>"
12  },
13  "collection_items": [
14    {
15      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
16      "created_at": "2024-01-15T09:30:00Z",
17      "created_by": "user_987654321",
18      "schema_version": 1,
19      "page_items": [
20        {
21          "type": "multiple_choice",
22          "answer_limit": 1,
23          "created_at": "2024-01-15T09:30:00Z",
24          "created_by": "user_987654321",
25          "description": "How satisfied are you with our product?",
26          "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
27          "options": [
28            {
29              "label": "Very satisfied",
30              "value": "very_satisfied",
31              "exclusive": false
32            },
33            {
34              "label": "Somewhat satisfied",
35              "value": "somewhat_satisfied",
36              "exclusive": false
37            },
38            {
39              "label": "Neutral",
40              "value": "neutral",
41              "exclusive": false
42            },
43            {
44              "label": "Somewhat dissatisfied",
45              "value": "somewhat_dissatisfied",
46              "exclusive": false
47            },
48            {
49              "label": "Very dissatisfied",
50              "value": "very_dissatisfied",
51              "exclusive": false
52            },
53            {
54              "label": "Prefer not to say",
55              "value": "prefer_not_to_say",
56              "exclusive": true
57            }
58          ],
59          "order": 1,
60          "parent_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
61          "parent_type": "collection",
62          "disable_dropdown": false,
63          "helper_text": "Select one option that best describes your satisfaction level.",
64          "placeholder_text_input": "Select an option"
65        }
66      ]
67    }
68  ],
69  "last_modified_at": "2024-01-20T15:45:00Z",
70  "last_modified_by": "user_123456789"
71}
Get a specific AI Task Builder Collection by its unique identifier.
Was this page helpful?
Previous

Create a Collection

Next

Update a Collection

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

collection_idstringRequired

Response

OK
idstringformat: "uuid"
schema_versionenum
Allowed values:
created_atdatetime

ISO-8601 formatted creation timestamp in UTC

created_bystring
User ID of the Prolific user that created the collection
workspace_idstring
The ID of the Prolific workspace
namestring
The name of the collection
task_detailsobject
Task metadata displayed to participants
collection_itemslist of objects
Pages within the collection. Each collection item represents a page.
last_modified_atdatetime

ISO-8601 formatted last modification timestamp in UTC

last_modified_bystring
User ID of the Prolific user that last modified the collection

Errors

4XX
Client Request Error