RefRef logoRefRef
SolutionsPricingDocsStart Free
PlatformAutomationsAPI
RefRef logoRefRef
API overview

Reference

Approve Partner Application POSTBan Partner POSTCapture Handle POSTChoose Reward Connection POSTCreate Benefit Rule POSTCreate Custom Unit POSTCreate Program POSTCreate Referral Code POSTCreate Referral Link POSTCreate Webhook Endpoint POSTDecline Partner Application POSTDelete Webhook Endpoint DELETEDiagnose Event GETEnd Enrollment POSTEnd Program POSTEnroll Participant POSTRecorded WebhookFulfill Reward POSTGet Delivery Settings GETGet Event GETGet Health GETGet Open Api Document GETGet Participant GETGet Partner GETGet Program Readiness GETGet Program Summary GETGet Program GETGet Referral GETGet Reward GETGet Root Health GETGet Widget Payout Details GETIdentify Handle POSTInitialize Widget POSTIntake Event POSTIntake Purchase Adjustment POSTIntake Subscription Fact POSTInvite Partner POSTList Benefit Rules GETList Connections GETList Custom Units GETList Events GETList Participants GETList Partner Applications GETList Partner Payouts GETList Partners GETList Program Rules GETList Program Templates GETList Programs GETList Projects GETList Purchases GETList Referee Offers GETList Referrals GETList Referrers GETList Reward Adjustments GETList Reward Evaluations GETList Reward Terms GETList Rewards GETList Webhook Deliveries GETList Webhook Endpoints GETList Webhook Events GETList Widget Referrals GETList Widget Rewards GETCreated WebhookApplication_approved WebhookApplication_declined WebhookApplication_submitted WebhookBanned WebhookEnrolled WebhookPause Program POSTFailed WebhookPaid WebhookReturned WebhookPublish Attribution Policy POSTPublish Program POSTPublish Referee Offer POSTPublish Reward Terms POSTRecord Referral POSTCreated WebhookVoided WebhookRekey Participant POSTRename Benefit Rule PUTResume Program POSTRetry Reward Delivery POSTRevoke Partner Invitation POSTRevoke Reward POSTEarned WebhookFulfilled WebhookRevoked WebhookVoided WebhookSave Widget Payout Details PUTSet Qualifying Event Types PUTSubmit Paid History POSTUnban Partner POSTUpdate Custom Unit PATCHUpdate Delivery Settings PUTUpdate Program PATCHUpsert Participant PUTVoid Referral POSTVoid Reward POST

Get Open Api Document

GET
/openapi

Response Body

text/yaml

curl -X GET "https://example.com/openapi"
"string"

Get Health GET

Previous Page

Get Participant GET

Read one participant with its enrollments, referral codes and links, the referral that names it as referee, its newest referrals as referrer, and its newest Events. Needs the participants:read and referrals:read key permission.