SolutionsPricingDocsStart Free
Api

List Referrers

GET
/v1/referrers

List the participants with an enrollment (open or ended), newest first, 50 per page. Needs the participants: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

Query Parameters

offset?string
Match^(0|[1-9][0-9]*)$
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/referrers?projectId=string"
{  "success": true,  "data": [    {      "id": "string",      "createdAt": "string",      "updatedAt": "string",      "projectId": "string",      "kind": "individual",      "externalId": "string",      "billingId": "string",      "name": "string",      "email": "string",      "partnerId": "string",      "deletedAt": "string"    }  ]}