v4

OpenAPI 3.1.02026-07-31121440441.0 KB

studies

Download credential usage report

Download a CSV report of credential usage for a study. The report includes participant IDs, submission IDs, usernames, and credential status (USED/UNUSED). This endpoint is only available for studies that have credentials configured.

get/api/v1/studies/{id}/credentials/report/

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

CSV file containing credential usage report

object required