List Collections | Prolific API

curl -G https://api.prolific.com/api/v1/data-collection/collections \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d workspace_id=a3f47b9e-8c2d-4f1a-9b7e-2d5f3c6a1b8e

{
  "results": [
    {
      "id": "d9b2d63d-a233-4123-847a-7a7a3f3f3f3f",
      "schema_version": 1,
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "user_12345",
      "workspace_id": "a3f47b9e-8c2d-4f1a-9b7e-2d5f3c6a1b8e",
      "name": "Customer Feedback Survey",
      "task_details": {
        "task_name": "Customer Satisfaction Survey",
        "task_introduction": "<p>Welcome to our survey! Your feedback is valuable.</p>",
        "task_steps": "<ol><li>Answer all questions honestly.</li><li>Submit your responses.</li></ol>"
      },
      "collection_items": [
        {
          "id": "e7c9f1a2-4b5d-4c6e-9f7a-1b2c3d4e5f6a",
          "created_at": "2024-01-15T09:30:00Z",
          "created_by": "user_12345",
          "schema_version": 1,
          "page_items": [
            {
              "type": "multiple_choice",
              "answer_limit": 1,
              "created_at": "2024-01-15T09:30:00Z",
              "created_by": "user_12345",
              "description": "How satisfied are you with our product?",
              "id": "f1a2b3c4-d5e6-7f8a-9b0c-1d2e3f4a5b6c",
              "options": [
                {
                  "label": "Very satisfied",
                  "value": "very_satisfied",
                  "exclusive": false
                },
                {
                  "label": "Somewhat satisfied",
                  "value": "somewhat_satisfied",
                  "exclusive": false
                },
                {
                  "label": "Neutral",
                  "value": "neutral",
                  "exclusive": false
                },
                {
                  "label": "Somewhat dissatisfied",
                  "value": "somewhat_dissatisfied",
                  "exclusive": false
                },
                {
                  "label": "Very dissatisfied",
                  "value": "very_dissatisfied",
                  "exclusive": false
                },
                {
                  "label": "Prefer not to say",
                  "value": "prefer_not_to_say",
                  "exclusive": true
                }
              ],
              "order": 1,
              "parent_id": "e7c9f1a2-4b5d-4c6e-9f7a-1b2c3d4e5f6a",
              "parent_type": "collection",
              "disable_dropdown": false,
              "helper_text": "Select one option that best describes your satisfaction level.",
              "placeholder_text_input": "Select an option"
            }
          ]
        }
      ],
      "last_modified_at": "2024-01-20T15:45:00Z",
      "last_modified_by": "user_67890"
    }
  ],
  "meta": {
    "count": 1
  }
}

Get all AI Task Builder Collections for a workspace.

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

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