incentiveIdstring required
type'MONEY_OR_GIFT_CARD' | 'CUSTOM' | 'RECRUITMENT_FEE' | 'RESPONDENT_MONEY' | 'null' nullable required
The type of the incentive
amountCentsinteger nullable required
The value of the incentive in cents
sentAtstring date-time required
When the incentive was sent
recipientEmailstring email nullable required
The email of the recipient. Null when the recipient has been deleted. Masked if the api key doesn't have permissions
personIdstring nullable required
participantIdstring nullable required
The ID of the participant
studyIdstring nullable required
status'UNCLAIMED' | 'CLAIMED' | 'CANCELED' | 'ERROR' | 'SENT' | 'EXPIRED' required
The payment status of the incentive. Money and Charity incentives move through UNCLAIMED -> CLAIMED, ERROR, CANCELED, EXPIRED. Custom Incentives have no flow and are always SENT. EXPIRED applies to incentives sent after Jan 31 2026 that remain unclaimed for 1 year.
budgetIdstring nullable required
teamIdstring nullable required
The ID of the team that owned the study when the incentive was sent
customIncentiveIdstring nullable
The ID of the custom incentive
customIncentiveValuestring nullable
The value of the custom incentive