> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.prolific.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.prolific.com/_mcp/server.

# Get taskflow progress

GET https://api.prolific.com/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).

Reference: https://docs.prolific.com/api-reference/studies/get-study-access-details-progress

## Authentication

- `Authorization` header (required) (prefixed with ` 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>`.

## Request

### Path parameters

- `id` (string, required) — Study id

## Response

### 200

Taskflow progress for the study's access details collection.

- `id` (string, required) — The access details collection ID for this study's Taskflow configuration.
- `progress` (list of AccessDetailProgress, required) — One row per `external_url` configured on the study.
- `_links` (map from string to any, optional) — HAL-style links; typically includes `self` pointing at this endpoint.

## Errors

### 400 Client Request Error

Error

- `error` (ErrorDetail, required)

## Types

### AccessDetailProgress

- `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` (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- or force-completion-driven capacity. For studies with custom screening (fixed screen-out reward) or force completion, `allocated` may exceed `total_allocation` — use `slot_increments` and `place_increments` to understand why.
- `allocated` (double, optional) — The number of participants currently allocated to this URL. This value may exceed `total_allocation`. This occurs when participants have been screened out or had their submission force-completed — each of these events adds 1 to `slot_increments` or `place_increments` respectively, allowing a replacement participant to be allocated. The relationship is always: `allocated ≤ total_allocation + slot_increments + place_increments`.
- `slot_increments` (double, optional) — 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, `slot_increments` is 3, `place_increments` is 0, 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.
- `place_increments` (double, optional) — The cumulative number of additional capacity slots added to this URL by force-completion events. Each time a participant's submission is force-completed, 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 force-completions have occurred.
- `capacity_increments` (double, optional, deprecated) — **Deprecated:** this field is being replaced by the separate `slot_increments` and `place_increments` fields. `capacity_increments` will continue to be returned with the same combined value (`slot_increments + place_increments`) that it always represented, but new integrations should read `slot_increments` and `place_increments` instead. Please migrate at your earliest convenience.

### ErrorDetail

- `status` (integer, required) — Status code as in the http standards
- `error_code` (integer, required) — Internal error code
- `title` (string, required) — Error title
- `detail` (ErrorDetailDetail, required) — Error detail
- `additional_information` (string, optional) — Optional extra information
- `traceback` (string, optional) — Optional debug information
- `interactive` (boolean, optional)

### ErrorDetailDetail

Error detail

### ErrorDetailDetail2

All fields with validation errors

- `any_field` (list of string, optional) — Name of the field with a validation error and as a value an array with the error descriptions

## Examples

**Response**

```json
{
  "id": "42a9f01f-3cd8-4cf0-b79a-9b2cd50a1e85",
  "progress": [
    {
      "external_url": "https://google.com",
      "total_allocation": 10,
      "allocated": 12,
      "slot_increments": 3,
      "place_increments": 0,
      "capacity_increments": 3
    },
    {
      "external_url": "https://bing.com",
      "total_allocation": 10,
      "allocated": 4,
      "slot_increments": 0,
      "place_increments": 0,
      "capacity_increments": 0
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.prolific.com/api/v1/studies/60aca280709ee40ec37d4885/access-details-progress/",
      "title": "Current"
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.prolific.com/api/v1/studies/id/access-details-progress/"

headers = {"Authorization": "Token <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.prolific.com/api/v1/studies/id/access-details-progress/';
const options = {method: 'GET', headers: {Authorization: 'Token <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prolific.com/api/v1/studies/id/access-details-progress/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Token <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prolific.com/api/v1/studies/id/access-details-progress/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.prolific.com/api/v1/studies/id/access-details-progress/")
  .header("Authorization", "Token <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prolific.com/api/v1/studies/id/access-details-progress/', [
  'headers' => [
    'Authorization' => 'Token <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.prolific.com/api/v1/studies/id/access-details-progress/");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Token <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prolific.com/api/v1/studies/id/access-details-progress/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```