v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB

studies

Get taskflow progress

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

get/api/v1/studies/{id}/access-details-progress/

Path parameters

idstring required

Study id

Headers

Authorizationstring required

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

Response

Taskflow progress for the study's access details collection.

idstring required

The access details collection ID for this study's Taskflow configuration.

_linksobject

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