Get Referral Details

get

https://{host}/v1.1/customer/referrals

Retrieves the stats of the referrals along with the unique referral code of a specific customer.

Query Params

mobile

string

Mobile number of the customer.

string

Email ID of the customer.

external_id

string

External ID of the customer.

int64

Unique ID of the customer.

campaign_token

string

Pass the specific token id of the referral campaign that you want to fetch. If no campaign id is passed, the details of the customer’s referral history of the default campaign will be retrieved

start_date

date

Get customers referred on or after a specific date (YYYY-MM-DD). To get referral history of a specific duration, pass the date range in start_date and end_date.

end_date

date

Get customers referred before a specific date (YYYY-MM-DD). To get referral history of a specific duration, pass the date range in start_date and end_date.

store_code

string

Retrieve referral stats of the specific store. Default value will be the current store. Set all to track details from all the stores

order_by

string

enum

Order the results by a specific entry. valid_till is for issued_till.

Allowed:

sort_order

string

enum

Sort the results in ascending (asc) or descending (desc) order of order_by.

Allowed:

limit

int32

Limit the number of results to be retrieved. For example: limit=10 to retrieve the history of ten recent coupons of the customer.

only_referral_code

boolean

Set true to retrieve the referral code of the respective referral campaigns (of the specific customer).

Responses

Language

Credentials

Basic

base64

URL

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400