---
title: "Get taskflow progress"
method: GET
path: "/api/v1/studies/{id}/access-details-progress/"
tags: ["studies"]
---

# Get taskflow progress

`GET /api/v1/studies/{id}/access-details-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).

## Path parameters

- `id` string, required

## Headers

- `Authorization` string, required

## Response `200`

Taskflow progress for the study's access details collection.

- StudyAccessDetailsProgress
  - `id` string, required — The access details collection ID for this study's Taskflow configuration.
  - `progress` AccessDetailProgress[], required — One row per `external_url` configured on the study.
    - `external_url` string, required — URL of the task you want to send the participant to. You can pass URL search parameters as in `external_study_url`.
    - `total_allocation` number, double, required — The base number of places set by the researcher for this URL. This is the value used to determine the study's total available places and will match what was submitted when creating or updating the study. This value does not include screenout-driven capacity. For studies with custom screening (fixed screen-out reward), `allocated` may exceed `total_allocation` — use `capacity_increments` to understand why.
    - `allocated` number, double — The number of participants currently allocated to this URL. For studies with custom screening (fixed screen-out reward), this value may exceed `total_allocation`. This occurs when participants have been screened out — each screenout adds 1 to `capacity_increments`, allowing a replacement participant to be allocated. The relationship is always: `allocated ≤ total_allocation + capacity_increments`.
    - `capacity_increments` number, double — The cumulative number of additional capacity slots added to this URL by screenout events. Each time a participant is screened out, this value increases by 1, allowing a replacement participant to be allocated in their place. This field is read-only and system-managed — it cannot be set when creating or updating a study. It will be absent (or 0) for URLs where no screenouts have occurred. **Example:** If `total_allocation` is 10, `capacity_increments` is 3, and `allocated` is 11, it means 3 participants were screened out, creating 3 extra slots, and 11 participants have been allocated in total — 2 slots remain.
  - `_links` object — HAL-style links; typically includes `self` pointing at this endpoint.

## Other responses

- `400` — Error

---

[API](https://skmtc.net/prolific/apis/api-reference.md) · [All operations](https://skmtc.net/prolific/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prolific/api-reference/versions/dc6f073a9827/schema)