H!HOPPA
GET/api/v2/referrals/links

Campaign links across the company's members (owner fields filled). status filters on the reported status.

Authentication

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

Parameters

Request parameters
FieldTypeRequiredDescription
programId (query)string (uuid)No
ownerUserId (query)unknownNo
status (query)stringNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
ProgramIdstring (uuid)Yes
ProgramNamestringYes
NamestringYes
CodestringYes
ChannelstringYes
LocalestringYes
DestinationstringYes
StatusstringYes
ActiveFromstring (date-time)Yes
ExpiresAtstring (date-time)Yes
CreatedAtstring (date-time)Yes
ShareUrlstringYes
SignupCountunknownYes
QualifiedCountunknownYes
ClickCountunknownYes
UniqueClickCountunknownYes
OfferVersionIdstring (uuid)Yes
SuggestedCaptionstringYes
OwnerUserIdunknownNo
OwnerNamestringNo
OwnerEmailstringNo

Example request

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

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