API ReferenceSubmissions

Retrieve a submission

View as MarkdownOpen in Claude
Returns the detailed information of a submission, including the study id, participant id, status and start timestamp

Authentication

Authorizationstring
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

Submission id. This is the ID we pass to the survey platform using %SESSION_ID%

Response

Found
idstring
The id of the submission
started_atstring

The date and time that the user started the submission (UTC)

statusenum
The current status of the submission
study_idstring
Study id.
completed_atstring or null
The time the submission was completed at.
entered_codestring or null
The completion code used by the participant to complete the study.
participantstring or null
Participant id.
parent_study_idstring or null

ID of the study’s parent, if any. (This applies to representative sample and quota studies.)

bonus_paymentslist of doubles or null

Bonus payments that have been paid on the submission. Returned in pence / cents.

return_requesteddatetime or null
The date and time when a return request for the submission was made.

Errors