List Collections

GET

https://api.prolific.com/api/v1/data-collection/collections

GET

/api/v1/data-collection/collections

1 import requests
2 
3 url = "https://api.prolific.com/api/v1/data-collection/collections"
4 
5 querystring = {"workspace_id":"workspace_id"}
6 
7 headers = {"Authorization": "Token <token>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

1 {
2   "results": [
3     {
4       "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "schema_version": 1,
6       "created_at": "2024-01-15T09:30:00Z",
7       "created_by": "jane.doe@example.com",
8       "workspace_id": "workspace-1234",
9       "name": "Customer Feedback Collection",
10       "task_details": {
11         "task_name": "Collect Customer Feedback",
12         "task_introduction": "Gather detailed feedback from customers about their recent purchase experience.",
13         "task_steps": "1. Send survey link to customers. 2. Collect responses. 3. Analyze feedback."
14       },
15       "collection_items": [
16         {
17           "id": "item-5678abcd-ef90-1234-5678-abcdef901234",
18           "created_at": "2024-01-15T09:30:00Z",
19           "created_by": "jane.doe@example.com",
20           "schema_version": 1,
21           "page_items": [
22             {
23               "id": "pageitem-1234abcd-5678-ef90-1234-abcdef567890",
24               "created_at": "2024-01-15T09:30:00Z",
25               "type": "multiple_choice",
26               "collection_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
27               "created_by": "jane.doe@example.com",
28               "description": "How satisfied are you with the product quality?",
29               "order": 1,
30               "answer_limit": 1,
31               "disable_dropdown": false,
32               "options": [
33                 {
34                   "label": "Very Satisfied",
35                   "value": "very_satisfied"
36                 },
37                 {
38                   "label": "Satisfied",
39                   "value": "satisfied"
40                 },
41                 {
42                   "label": "Neutral",
43                   "value": "neutral"
44                 },
45                 {
46                   "label": "Dissatisfied",
47                   "value": "dissatisfied"
48                 },
49                 {
50                   "label": "Very Dissatisfied",
51                   "value": "very_dissatisfied"
52                 }
53               ],
54               "last_modified_at": "2024-01-15T09:30:00Z",
55               "last_modified_by": "jane.doe@example.com"
56             }
57           ],
58           "last_modified_at": "2024-01-15T09:30:00Z",
59           "last_modified_by": "jane.doe@example.com"
60         }
61       ],
62       "last_modified_at": "2024-01-15T09:30:00Z",
63       "last_modified_by": "jane.doe@example.com"
64     }
65   ],
66   "meta": {
67     "count": 1
68   }
69 }

Get all AI Task Builder Collections for a workspace.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

workspace_idstringRequired

The unique identifier of the workspace

Response

resultslist of objects or null

metaobject or null

Authentication

Query parameters

Response

Errors