API Documentation

Get Customer Details

get
https://{host}/v2/customers/lookup/customerDetails

Retrieves all the details of a customer. Use embed and other parameters to get a specific information as per needed.

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

Source on which the customer identifier is available.

Allowed:
string

Account ID for sources with multiple accounts.

string
enum

Details to be included in the response.
Values: points, subscriptions, mlp, promotionalPoints, expirySchedules, expiredPoints, segments, userGroup, gapDetails, customerImage, cardLoyaltyDetails, fleetParentDetails, ignoreCardDetails, customerStatus.

string
enum
required

Identifier type used to get the customer details.

Allowed:
string
required

Value of the specified identifier.

boolean

Pass true to fetch fraud details of the customer if available.

boolean
Defaults to false

Pass true to include group loyalty details in the response.

int64

Unique ID of the user group to fetch customer details of that specific group.

boolean
Defaults to false

Pass true to fetch customer details across all the groups of the customer.

Headers
string
string

Specify the ISO language code to get customer level extended field details in your preferred language. For example, zh for Chinese, id for Indonesian, ar for Arabic. English is the default language.

Response

Updated about 2 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago