Sign in

v4

OpenAPI 3.1.02026-07-31121440441.0 KB
submissions

Retrieve a submission

Returns the detailed information of a submission, including the study id, participant id, status and start timestamp

get/api/v1/submissions/{id}/

Path parameters

idstring required

Submission id. This is the ID we pass to the survey platform using %SESSION_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

Found

idstring required

The id of the submission

completed_atstring nullable

The time the submission was completed at.

entered_codestring nullable

The completion code used by the participant to complete the study.

participantstring

Participant id.

started_atstring required

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

status'ACTIVE' | 'APPROVED' | 'PARTIALLY APPROVED' | 'AWAITING REVIEW' | 'REJECTED' | 'RESERVED' | 'RETURNED' | 'TIMED-OUT' | 'SCREENED OUT' | 'UNKNOWN' required

The current status of the submission

study_idstring required

Study id.

parent_study_idstring nullable

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

bonus_paymentsnumber[]

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

return_requestedstring date-time nullable

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