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

Download credential usage report

|View as Markdown|Open in Claude|
GET
https://api.prolific.com/api/v1/studies/:id/credentials/report/
GET
/api/v1/studies/:id/credentials/report/
$curl https://api.prolific.com/api/v1/studies/id/credentials/report/ \
>     -H "Authorization: Token <token>"
1"Participant Id,Submission Id,Username,Status\n68f8d0ca8efecd55f465ef02,68f8eb508f56127117b58491,fake_user_1,USED\n68f8e1d75c5b0801988d377a,68f8f6ac43473bf358b2def1,fake_user_2,USED\n,,fake_user_3,UNUSED\n,,fake_user_4,UNUSED\n"

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.

Was this page helpful?
Previous

Count study submissions by status

Next

Download demographic data

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

CSV file containing credential usage report

Errors

400
Bad Request Error
4XX
Client Request Error