GET
/api/v2/users/{userId}/referrals/level-lifecycleGET /api/v2/users/{userId}/referrals/level-lifecycle
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | integer (int32) | Yes | |
| programId (query) | string (uuid) | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| ProgramId | string (uuid) | Yes | |
| UserId | unknown | Yes | |
| AsOf | string (date-time) | Yes | |
| ObservedAt | string (date-time) | Yes | |
| CurrentLevel | object | Yes | |
| Assigned | boolean | Yes | |
| Progress | ReferralMetricProgressResponse | Yes | Progress towards the next visible level. Basis/CurrentValue/NextThreshold/Remaining are the legacy single-metric view (qualified referrals); the per-condition fields are null when the next level does not set that condition and 0 when it is already met. |
| Forecast | object | Yes | |
| ProtectedRelationshipCount | unknown | Yes | |
| ExistingOffersProtected | boolean | No | |
| ForecastAssumption | string | No |
Example request
curl -X GET "https://{base_url}/api/v2/users/{userId}/referrals/level-lifecycle" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.