Paginated list of participants in a study
Get a paginated list of participants in a study. Filtering currently not supported
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Filter option to search for people
A custom property filter
EQUAL, NOT_EQUAL CUSTOM_PROPERTY BOOLEAN IS, IS_NOT, IS_BEFORE, IS_AFTER, IS_ON_OR_BEFORE, IS_ON_OR_AFTER, IS_WITHIN, IS_EMPTY, IS_NOT_EMPTY INCENTIVE SENT_AT DATETIME TODAY, TOMORROW, YESTERDAY, ONE_WEEK_AGO, ONE_WEEK_FROM_NOW, ONE_MONTH_AGO, ONE_MONTH_FROM_NOW, ONE_YEAR_AGO, ONE_YEAR_FROM_NOW, NUMBER_OF_DAYS_AGO, NUMBER_OF_DAYS_FROM_NOW, EXACT_DATE IS, IS_NOT, IS_BEFORE, IS_AFTER, IS_ON_OR_BEFORE, IS_ON_OR_AFTER, IS_WITHIN, IS_EMPTY, IS_NOT_EMPTY PARTICIPANT INTERVIEW_START_TIME, INTERVIEW_START_DATE, SCREENER_SENT_AT, SCREENER_SUBMITTED_AT DATETIME TODAY, TOMORROW, YESTERDAY, ONE_WEEK_AGO, ONE_WEEK_FROM_NOW, ONE_MONTH_AGO, ONE_MONTH_FROM_NOW, ONE_YEAR_AGO, ONE_YEAR_FROM_NOW, NUMBER_OF_DAYS_AGO, NUMBER_OF_DAYS_FROM_NOW, EXACT_DATE IS, IS_NOT, IS_BEFORE, IS_AFTER, IS_ON_OR_BEFORE, IS_ON_OR_AFTER, IS_WITHIN, IS_EMPTY, IS_NOT_EMPTY PERSON IMPORT_DATE, LAST_CONTACT_DATE, LAST_INTERVIEW_DATE, LAST_UNMOD_TEST_DATE, LAST_SURVEY_DATE, CONTACT_STATUS_UPDATE_DATE, LAST_CHANGED_AT DATETIME TODAY, TOMORROW, YESTERDAY, ONE_WEEK_AGO, ONE_WEEK_FROM_NOW, ONE_MONTH_AGO, ONE_MONTH_FROM_NOW, ONE_YEAR_AGO, ONE_YEAR_FROM_NOW, NUMBER_OF_DAYS_AGO, NUMBER_OF_DAYS_FROM_NOW, EXACT_DATE AND, OR Response
Information about the current page
Whether there are additional pages of results
Whether there is a prior page of results
The end of the current page of results. Use to fetch the next page
The start of the current page of results
The date the participant was added to the study
The additional emails of the participant
The approval status of the participant
HIDDEN, AWAITING_APPROVAL, APPROVED, REJECTED, REPORTED The date the participant was approved
The primary email of the participant
The date the participant was invited to the study
The ID of the participant
The ID of the person
The date the screener was sent
The screener state of the participant
SCREENER_SENT, SCREENER_COMPLETED, QUALIFIED, AUTO_QUALIFIED, NOT_QUALIFIED, AUTO_NOT_QUALIFIED The status of the participant
NOT_STARTED, INVITE_SENT, NOT_ELIGIBLE, SCREENER_STARTED, SCREENER_COMPLETED, SCREENER_QUALIFIED, SCREENER_DISQUALIFIED, INTERVIEW_INVITE_SENT, INTERVIEW_SCHEDULED, INTERVIEW_COMPLETED, INTERVIEW_CANCELLED, INTERVIEW_NO_SHOWED, SURVEY_STARTED, SURVEY_COMPLETED, INCENTIVE_SENT, INCENTIVE_CLAIMED, UNMODERATED_TEST_INVITE_SENT, UNMODERATED_TEST_STARTED, UNMODERATED_TEST_COMPLETED, COMPLETED_STUDY, CANCELLED, OPTED_OUT The ID of the study
The total number of items in your workspaces based on your search parameters
x > 0