GET/api/v2/referral-invitations/preview

Resolves a signed invitation so a registration client can prefill its bound email and referral code.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
token (query)stringNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
EmailstringYes
ReferralCodestringYes
InviterDisplayNamestringYes
ExpiresAtstring (date-time)Yes

Example request

curl -X GET "https://{base_url}/api/v2/referral-invitations/preview" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.