SolutionsPricingDocsStart Free
PlatformAutomationsAPI

Get Program Readiness

GET
/v1/programs/{programId}/readiness

Check whether a Program can go live: the problems that block publish_program (no enabled rule, no referrer rule, no landing page of an affiliate Program, cash paid out by RefRef on a plan without cash payouts) and the warnings that do not. Needs the programs:read key permission.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Path Parameters

programId*string
Length1 <= length <= 128

Query Parameters

projectId*string
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/programs/string/readiness?projectId=string"
{  "success": true,  "data": {}}

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.

Get Program Summary GET

Read the totals of a Program: participants, referrals, conversions, and Rewards. Needs the referrals:read key permission.