Skip to main content
GET
Get available referrals

Authorizations

Authorization
string
header
required

Your affiliate API key (Profile → API & AI tools in the affiliate dashboard), sent as Authorization: Bearer {api_key}

Headers

Account-ID
string
required

Account ID of the affiliate program, shown next to your API key under Profile → API & AI tools

Example:

"acc_123456"

Query Parameters

q
string

Search params. Searches by email, uid, username, website

filters[type]
enum<string>

Type (lead or customer)

Available options:
lead,
customer
filters[state]
enum<string>

State

Available options:
subscribed,
signup,
active,
cancelled,
refunded,
denied,
pending,
moved
filters[created_at][from]
string<date>

created_at start date

filters[created_at][to]
string<date>

created_at end date

filters[customer_since][from]
string<date>

customer_since start date

filters[customer_since][to]
string<date>

customer_since end date

filters[campaign_id]

Campaign ids. Can be Integer or an Array of Integers

sorting[state]
enum<string>

Sort by state direction

Available options:
asc,
desc
sorting[email]
enum<string>

Sort by email direction

Available options:
asc,
desc

Response

Successful response

id
integer
uid
string
state
enum<string>
Available options:
subscribed,
signup,
active,
cancelled,
refunded,
denied,
pending,
moved
metadata
object
created_at
string<date-time>
customer_since
string<date-time>
email
string<email>
promoter_campaign
object
username
string | null
visitor_sub_id
string | null
first_name
string | null
last_name
string | null
website
string | null
comment
string | null
split_details
object | null
billing_country
string | null
is_expired
boolean
custom_status
object | null

Custom referral status set by the program, if any