Get paginated list of incentives
Gets all incentives in your workspace
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Search parameters to get incentives within your workspace
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 The ID of the study
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 value of the incentive in cents
x > 0The ID of the budget
The ID of the incentive
The ID of the participant
The ID of the person
The email of the recipient. Masked if the api key doesn't have permissions
When the incentive was sent
The payment status of the incentive
ERROR, PENDING, SENT, UNCLAIMED, CLAIMED, CANCELED The ID of the study
The type of the incentive
MONEY_OR_GIFT_CARD, CUSTOM, RECRUITMENT_FEE, RESPONDENT_MONEY The ID of the custom incentive
The value of the custom incentive
The total number of items in your workspaces based on your search parameters
x > 0