SolutionsPricingDocsStart Free
Api

Get Referral

GET
/v1/referrals/{id}

Read one referral: referrer, referee, Program, enrollment, and touch. Needs the referrals: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

id*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/referrals/string?projectId=string"
{  "success": true,  "data": {    "id": "string",    "createdAt": "string",    "updatedAt": "string",    "projectId": "string",    "referrerParticipantId": "string",    "refereeParticipantId": "string",    "enrollmentId": "string",    "programId": "string",    "touchId": "string",    "bindingEventId": "string",    "bindingSubscriptionFactId": "string",    "bindingOccurredAt": "string",    "selectedAt": "string",    "policyVersionId": "string"  }}