PRprolific
submissions

List submissions

Changed on

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
get/api/v1/submissions/

Request

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

Query parameters

studystring required

Filter by study ID (required). This is the ID we pass to the survey platform using %STUDY_ID%

status'ACTIVE' | 'AWAITING_REVIEW' | 'APPROVED' | 'PARTIALLY_APPROVED' | 'REJECTED' | 'RETURNED' | 'SCREENED_OUT' | 'TIMED-OUT' | 'UNKNOWN'

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

completed'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

returned'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

awaiting_review'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

approved'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

active'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

timeout'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

rejected'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

screened_out'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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

completeoractive'0' | '1' | 'true' | 'false' | 'yes' | 'no' | 't' | 'f'

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_fromstring

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

submitted_beforestring

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

ordering'started_at' | '-started_at' | 'submission_reward' | '-submission_reward' | 'study_name' | '-study_name'

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

page_sizeinteger

Number of items to return per page (Default 20)

pageinteger

Page number to retrieve (Default 1)

Response

List submissions

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • 99b5dc540b1cRevision changes
    • info

      added the optional property // to the response with the status