GET
/api/v2/users/{userId}/referrals/linksThe member's campaign links, newest first. status filters on the reported status (ACTIVE, PAUSED, EXPIRED, ARCHIVED).
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 | |
| status (query) | string | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| ProgramId | string (uuid) | Yes | |
| ProgramName | string | Yes | |
| Name | string | Yes | |
| Code | string | Yes | |
| Channel | string | Yes | |
| Locale | string | Yes | |
| Destination | string | Yes | |
| Status | string | Yes | |
| ActiveFrom | string (date-time) | Yes | |
| ExpiresAt | string (date-time) | Yes | |
| CreatedAt | string (date-time) | Yes | |
| ShareUrl | string | Yes | |
| SignupCount | unknown | Yes | |
| QualifiedCount | unknown | Yes | |
| ClickCount | unknown | Yes | |
| UniqueClickCount | unknown | Yes | |
| OfferVersionId | string (uuid) | Yes | |
| SuggestedCaption | string | Yes | |
| OwnerUserId | unknown | No | |
| OwnerName | string | No | |
| OwnerEmail | string | No |
Example request
curl -X GET "https://{base_url}/api/v2/users/{userId}/referrals/links" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.