GET/api/v2/referrals/relationships

GET /api/v2/referrals/relationships

Authentication

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

Parameters

Request parameters
FieldTypeRequiredDescription
ProgramId (query)string (uuid)No
Search (query)stringNo
Stage (query)stringNo
Source (query)stringNo
InviterUserId (query)unknownNo
FriendUserId (query)unknownNo
AfterId (query)unknownNo
PageSize (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Itemsarray of ReferralRelationshipRowYes
NextCursorunknownYes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/relationships" \
  -H "x-api-key: YOUR_API_KEY"

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