List all referrals

get

https://developer-api.rivo.io/merchant_api/v1/referrals

List all referrals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pagination[per_page]

int32

pagination[page]

int32

pagination[since_id]

int32

pagination[limit]

int32

sort[order_direction]

string

enum

Allowed:

sort[order_type]

string

enum

Allowed:

filters[referral_campaign_id]

int32

Filter referrals by campaign ID

filters[referrer_customer_id]

int32

Filter referrals by referrer Shopify Customer ID

filters[referred_customer_id]

int32

Filter referrals by referred Shopify Customer ID

filters[status]

string

enum

Filter referrals by status

Allowed:

filters[updated_at][gte]

string

Filter referrals updated at or after this timestamp (ISO8601 format)

filters[updated_at][lt]

string

Filter referrals updated before this timestamp (ISO8601 format)

Headers

Authorization

string

required

Merchant Auth Token

Response

200

List all referrals

Language

Loading…

Response

Click Try It! to start a request and see the response here!