SolutionsPricingDocsStart Free
Api

List Program Rules

GET
/v1/programs/{programId}/benefit-rules

List the benefit rules of a Program. 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
Match\S
Length1 <= length <= 512

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/benefit-rules?projectId=string"
{  "success": true,  "data": [    {      "id": "string",      "createdAt": "string",      "updatedAt": "string",      "projectId": "string",      "programId": "string",      "eventType": "string",      "beneficiaryRole": "referrer",      "purpose": "primary",      "name": "string",      "initialEffectiveAt": "string"    }  ]}