PRprolific
submissions

Retrieve a submission

Changed on

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

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

Request

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

Path parameters

idstring required

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

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.

Changes