Get Customer Details

get

https://{host}/v2/customers/{customerId}

Retrieves the details of a customer from a specific source. Use embed to other parameters to fetch specific details required.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

int64

required

Unique ID of the customer to fetch details.

Query Params

source

string

enum

required

Allowed:

accountId

string

embed

array of strings

Details to include in the response. Supported value: points, subscriptions, mlp, userGroup, gapDetails, promotionalPoints, expirySchedules, expiredPoints, customerImage, 'returnedPoints', 'associatedImages'

embed

includedAllUserGroup2

boolean

Defaults to false

Pass true to see the customer details in all user groups.

userGroup2Id

int64

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

includedUserGroup2LoyaltyDetails

boolean

Defaults to false

Pass true to include loyalty details of user groups.

includedFraudDetails

boolean

Defaults to false

Pass true to include fraud details of the customer in the response.

includedOnlyCurrentProfile

boolean

Defaults to false

Pass true to fetch details of the current source. It hides information from other sources.

ug2JoinedStartDate

date

Start date for filtering customers who joined user groups.

ug2JoinedEndDate

date

End date for filtering customers who joined user groups.

ug2Offset

int32

Specifies the offset for pagination of user group results.

ug2Limit

int32

Sets the maximum number of results to retrieve per page for user groups.

ug2SortBy

string

Defaults to JoinedDate

Specifies the field by which the user group results should be sorted.

ug2SortOrder

string

enum

Defaults to DESC

Specifies the sorting order for the user group results.

Allowed:

ug2PaginationDetails

boolean

Pass true to include pagination details for user groups.

Headers

X-CAP-API-OAUTH-TOKEN

string

required

language

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.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

500500