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
    • Studies
      • The study object
      • GETList all studies
      • POSTCreate a draft study
      • GETList all studies in a project
      • GETRetrieve a study
      • DELDelete a study
      • PATCHUpdate a study
      • POSTTransition a study's status
      • POSTCreate a test study
      • GETGet taskflow progress
      • GETShow Study cost
      • GETList study submissions
      • GETCount study submissions by status
      • GETDownload credential usage report
      • GETDownload demographic data
      • POSTExport demographic data
      • GETGet demographic export history
      • POSTDuplicate a study
      • GETShow Study predicted recruitment time
      • POSTShow Study predicted recruitment time
      • POSTCalculate the study cost
    • 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 ReferenceStudies

Get taskflow progress

|View as Markdown|Open in Claude|
GET
https://api.prolific.com/api/v1/studies/:id/access-details-progress/
GET
/api/v1/studies/:id/access-details-progress/
$curl https://api.prolific.com/api/v1/studies/id/access-details-progress/ \
>     -H "Authorization: Token <token>"
1{
2  "id": "42a9f01f-3cd8-4cf0-b79a-9b2cd50a1e85",
3  "progress": [
4    {
5      "external_url": "https://google.com",
6      "total_allocation": 10,
7      "allocated": 12,
8      "capacity_increments": 3
9    },
10    {
11      "external_url": "https://bing.com",
12      "total_allocation": 10,
13      "allocated": 4,
14      "capacity_increments": 0
15    }
16  ],
17  "_links": {
18    "self": {
19      "href": "https://api.prolific.com/api/v1/studies/60aca280709ee40ec37d4885/access-details-progress/",
20      "title": "Current"
21    }
22  }
23}
Returns per-URL allocation progress for a Taskflow study (studies configured with `access_details`). Each item in `progress` corresponds to one `external_url` from the study's access details, including how many participants are allocated and any screenout-driven capacity increments. Returns **404** if the study has no access-details collection (not a Taskflow study).
Was this page helpful?
Previous

Create a test study

Next

Show Study cost

Returns per-URL allocation progress for a Taskflow study (studies configured with access_details). Each item in progress corresponds to one external_url from the study’s access details, including how many participants are allocated and any screenout-driven capacity increments.

Returns 404 if the study has no access-details collection (not a Taskflow study).

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

idstringRequired
Study id

Response

Taskflow progress for the study's access details collection.
idstring
The access details collection ID for this study's Taskflow configuration.
progresslist of objects

One row per external_url configured on the study.

_linksmap from strings to any

HAL-style links; typically includes self pointing at this endpoint.

Errors

4XX
Client Request Error