Get a Collection | Prolific API

curl https://api.prolific.com/api/v1/data-collection/collections/collection_id \
     -H "Authorization: <apiKey>"

{
  "id": "a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7a8d9e",
  "schema_version": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "jane.doe@example.com",
  "workspace_id": "workspace_12345",
  "name": "Customer Feedback Analysis",
  "task_details": {
    "task_name": "Analyze Customer Feedback",
    "task_introduction": "This task involves reviewing customer feedback to identify key themes and sentiment.",
    "task_steps": "1. Collect feedback data\n2. Categorize feedback\n3. Summarize key points\n4. Report findings"
  },
  "collection_items": [
    {
      "id": "b7e2f3a4-5c6d-7e8f-9012-3456789abcde",
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "jane.doe@example.com",
      "schema_version": 1,
      "page_items": [
        {
          "id": "c8d9e0f1-2345-6789-abcd-ef0123456789",
          "created_at": "2024-01-15T09:30:00Z",
          "type": "multiple_choice",
          "collection_id": "a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7a8d9e",
          "created_by": "jane.doe@example.com",
          "description": "What is the overall sentiment of the feedback?",
          "order": 1,
          "answer_limit": 1,
          "disable_dropdown": false,
          "options": [
            {
              "label": "Positive",
              "value": "positive"
            },
            {
              "label": "Neutral",
              "value": "neutral"
            },
            {
              "label": "Negative",
              "value": "negative"
            }
          ],
          "last_modified_at": "2024-01-15T09:30:00Z",
          "last_modified_by": "jane.doe@example.com"
        }
      ],
      "last_modified_at": "2024-01-15T09:30:00Z",
      "last_modified_by": "jane.doe@example.com"
    }
  ],
  "last_modified_at": "2024-01-15T09:30:00Z",
  "last_modified_by": "jane.doe@example.com"
}

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

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

collection_idstringRequired

Response

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 or null

ISO-8601 formatted last modification timestamp in UTC

last_modified_bystring or null

User ID of the Prolific user that last modified the collection

Authentication

Path parameters

Response

Errors