Fetch Referrals

get

https://platform.nector.io/api/v2/merchant/referrals

Fetch the referrals of a customer, either the ones they made (referred_by_lead_id) or the one they joined through (referred_to_lead_id), plus a per day count by status in stats.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

referred_by_lead_id

uuid

(This needs to be leads _id value) (one of referred_to_lead_id or referred_by_lead_id is required)

referred_to_lead_id

uuid

(This needs to be leads _id value) (one of referred_to_lead_id or referred_by_lead_id is required)

uuid

(This needs to be referrals _id value)

page

number

≥ 1

(Minimum is 1)

limit

number

1 to 100

(Minimum is 1) (Maximum is 100)

sort

string

enum

(This can only be one of created_at,updated_at)

Allowed:

sort_op

string

enum

(This can only be one of ASC,DESC)

Allowed:

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists