PRprolific
studies

Download credential usage report

Changed on

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/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/studies/{id}/credentials/report/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Study id

Response

CSV file containing credential usage report

object required

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id download-study-credential-report removed and replaced with studies_DownloadStudyCredentialReport