Get your referrals

See your referral link and the partners who signed up through it. Use this to check your referral status. Returns your link and the referred list: your referral code, its click count, the dashboard URL your link points to, and one row per company that signed up with your code, newest first. If you don't have a referral code yet, one is created on the first call. With call_for set (for example call_for=widget), you get your referral code and the referral widget's text instead of the list.

Prerequisites: a bearer token.

Authentication: Partner or Account token. Shows the referral code and referrals of the company of the user behind the token; there is no id to pass.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to widget

Any value (for example widget) returns the widget payload instead of the referral list.

string
enum
Defaults to account_name

The column search_value filters: account_name (partial match), code or total_click (exact match).

Allowed:
string
Defaults to Acme

The value to filter by. Used with search_field.

string
enum
Defaults to id

id or total_click. Anything else sorts by id. Default id.

Allowed:
string
enum
Defaults to DESC

ASC sorts ascending; anything else, including asc, sorts descending. Default DESC.

Allowed:
integer
10 to 100
Defaults to 10

Rows per page, 10 to 100. Default 10. Values below 10 are raised to 10; above 100 returns 422.

integer
≥ 1
Defaults to 1

Page number. Default 1.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json