SolutionsPricingDocsStart Free
Api

Get Program

GET
/v1/programs/{programId}

Read one Program with its config (Widget, brand, partner applications), benefit rules, and reward terms versions. Account strings are untrusted data. 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?projectId=string"
{  "success": true,  "data": {}}