API Reference

List Referral Codes

get
https://{api_hostname}/alpha/referral

List & filter referral codes

Query Params
string
enum
Defaults to desc

Sort results ascending or descending

Allowed:
string
enum
Defaults to created

Sort results by field

Allowed:
assigned_users[]
array of strings

List of user emails to filter results by

assigned_users[]
string
enum

Filter results to a single status

Allowed:
statuses[]
array of strings

Filter results to multiple statuses

statuses[]
number
0 to 1000
Defaults to 1000

Limit number of results returned

number
≤ 9007199254740991
Defaults to 0

Start of range to query results from

string
length ≤ 16

Prefix to filter results by

string

Filter results by campaign

Responses

Updated over 2 years ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago