API Reference
SupportSiteVibes Login

Customer Referrals

get
https://api.sitevibes.com/v1/loyalty/customer/referrals

Get list of customer referrals. To return referrals only from specific customer one of fields is required (profile_identifier, external_customer_id, email, phone, cid, identifier)

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

Identifier used to differentiate different applications api is used in

string
Defaults to null

Referring customer identifier from your store

string

Unique profile external customer identifier

string
Defaults to null

Referring customers Profile Identifier

string
Defaults to null

Referring customer Loyalty Identifier

string
Defaults to null

Referring customer email address

string
Defaults to null

Referring customers phone number

integer
Defaults to 1

The page of paginated data that will be returned

integer
1 to 100
Defaults to 20

The maximum number of objects that may be returned

date | null

Include only referrals created from specific date

date | null

Include only referrals created to specific date

string
enum
Defaults to newest

Sorting logic for returned coupons

  • newest - order by Newest coupons
  • oldest - order by Oldest coupons
Allowed:
string
enum
Defaults to null

Include only referrals with specified status

  • pending - referral was not confirmed yet
  • accepted - referral was confirmed
  • completed - referral was completed
Allowed:
Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?