Customer Data

get

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

Returns customer data. To identify customer one of fields is required (profile_identifier, external_customer_id, email, phone, cid, identifier)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

app_id

string

required

Identifier used to differentiate different applications api is used in

profile_identifier

string

Customers profile identifier

string

Customers email address

phone

string

Customers phone number

cid

string

Unique customer identifier from your store

external_customer_id

string

Unique profile external customer identifier

identifier

string

Customer Loyalty Identifier

ways_to_redeem

boolean

Defaults to false

include Ways to Redeem available for customer in response

ways_to_earn

boolean

Defaults to false

include Ways to Earn available for customer in response

earn_types

boolean

Defaults to false

include customer latest earn types (Points earned) in response

activity

boolean

Defaults to false

include customer latest activity (Points changes) in response

rewards

boolean

Defaults to false

include customer active coupon rewards in response

points_exchange

boolean

Defaults to false

include customer available points exchange value in response

active_promotion

boolean

Defaults to false

include active promotion window data if promotion is active for customer

Responses

200Success

401Access token is missing or invalid

422Some required fields are missing or invalid