SolutionsPricingDocsStart Free
Api

Get Participant

GET
/v1/participants/{id}

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.

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/participants/string?projectId=string"
{  "success": true,  "data": {    "participant": {      "id": "string",      "createdAt": "string",      "updatedAt": "string",      "projectId": "string",      "kind": "individual",      "externalId": "string",      "billingId": "string",      "name": "string",      "email": "string",      "partnerId": "string",      "deletedAt": "string"    },    "enrollments": [      {        "id": "string",        "createdAt": "string",        "updatedAt": "string",        "projectId": "string",        "participantId": "string",        "programId": "string",        "startsAt": "string",        "endsAt": "string"      }    ],    "refCodes": [      {        "id": "string",        "createdAt": "string",        "updatedAt": "string",        "projectId": "string",        "code": "string",        "participantId": "string",        "programId": "string"      }    ],    "links": [      {        "id": "string",        "createdAt": "string",        "updatedAt": "string",        "projectId": "string",        "slug": "string",        "refCodeId": "string"      }    ],    "referredBy": {      "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"    },    "referrals": [      {        "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"      }    ],    "events": [      {        "id": "string",        "createdAt": "string",        "updatedAt": "string",        "projectId": "string",        "participantId": "string",        "type": "string",        "actorParticipantId": "string",        "sourceNamespaceId": "string",        "sourceEventId": "string",        "occurredAt": "string",        "receivedAt": "string",        "normalizedFacts": {          "property1": null,          "property2": null        },        "factsHash": "string",        "processingState": "pending",        "processingReason": "awaiting_attribution",        "attemptCount": 0,        "nextAttemptAt": "string"      }    ]  }}