GET
/api/v2/referrals/relationships/{relationshipId}GET /api/v2/referrals/relationships/{relationshipId}
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| relationshipId (path) | string (uuid) | Yes |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Relationship | ReferralRelationshipRow | Yes | |
| Conditions | array of ReferralQualificationCondition | Yes | |
| Events | array of ReferralRelationshipEvidence | Yes | |
| TermsVersionAccepted | unknown | Yes | |
| AcceptedAt | string (date-time) | Yes | |
| CampaignLinkId | string (uuid) | Yes | |
| EligibleVolumeTotal | unknown | Yes | |
| ReservedExposure | unknown | Yes | |
| AsOf | string (date-time) | Yes | |
| EventsTruncated | boolean | No |
Example request
curl -X GET "https://{base_url}/api/v2/referrals/relationships/{relationshipId}" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.