API ReferenceSubmissions

List submissions

View as MarkdownOpen in Claude
Returns basic information of submissions, including study id, participant id, status and start timestamp. **Filtering and Ordering:** - Filter by status, completion state, dates, and study - Order by start time, reward amount, or study name - Paginate by page_size and page (Default page_size is 20) - Boolean parameters accept multiple formats: 1/0, true/false, yes/no, t/f (case-insensitive) - Date parameters use DD/MM/YYYY format - Status parameters are case-insensitive with underscore normalization

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>`.

Query Parameters

studystringOptional

Optional filter by study ID. This is the ID we pass to the survey platform using %STUDY_ID%

statusenumOptional

Filter by submission status (case-insensitive). Valid values include ACTIVE, AWAITING_REVIEW, APPROVED, REJECTED, RETURNED, SCREENED_OUT, TIMED-OUT

completedenumOptional

Filter by completion status. Accepts 1/true/yes/t for completed, 0/false/no/f for incomplete (case-insensitive)

returnedenumOptional

Filter by returned status. Accepts 1/true/yes/t for returned, 0/false/no/f for not returned (case-insensitive)

awaiting_reviewenumOptional

Filter by awaiting review status. Accepts 1/true/yes/t for awaiting review, 0/false/no/f for not awaiting review (case-insensitive)

approvedenumOptional

Filter by approved status. Accepts 1/true/yes/t for approved, 0/false/no/f for not approved (case-insensitive)

activeenumOptional

Filter by active status. Accepts 1/true/yes/t for active, 0/false/no/f for not active (case-insensitive)

timeoutenumOptional

Filter by timed out status. Accepts 1/true/yes/t for timed out, 0/false/no/f for not timed out (case-insensitive)

rejectedenumOptional

Filter by rejected status. Accepts 1/true/yes/t for rejected, 0/false/no/f for not rejected (case-insensitive)

screened_outenumOptional

Filter by screened out status. Accepts 1/true/yes/t for screened out, 0/false/no/f for not screened out (case-insensitive)

completeoractiveenumOptional

Filter for submissions that are either completed or active. Accepts 1/true/yes/t to include, 0/false/no/f to exclude (case-insensitive)

submitted_fromstringOptionalformat: "^[0-3][0-9]/[0-1][0-9]/[0-9]{4}$"

Filter submissions completed after the given date. Format DD/MM/YYYY (e.g., 01/01/2024)

submitted_beforestringOptionalformat: "^[0-3][0-9]/[0-1][0-9]/[0-9]{4}$"

Filter submissions completed before the given date. Format DD/MM/YYYY (e.g., 31/12/2024)

orderingenumOptional

Order results by field. Prefix with ’-’ for descending order. Supported values are started_at, submission_reward, study_name

page_sizeintegerOptional

Number of items to return per page (Default 20)

pageintegerOptional

Page number to retrieve (Default 1)

Response

List submissions
resultslist of objects
List of all submissions matching the criteria.

Errors