Skip to main content
GET
/
referral_links
Get current promoter referral links
curl --request GET \
  --url https://api.firstpromoter.com/api/v2/affiliate/referral_links \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "name": "<string>",
    "url": "<string>",
    "is_default": true,
    "source": "campaign",
    "sub_id": "<string>",
    "campaign": {
      "id": 123,
      "name": "<string>",
      "color": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

​
Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

​
promoter_campaign_id
integer

If provided, it returns only the links related to the given campaign

Response

List of referral links

​
id
integer | null
​
name
string
​
url
string
​
is_default
boolean | null
​
source
enum<string>
Available options:
campaign,
promoter
​
sub_id
string | null
​
campaign
object