Get badges for customer

get

https://{host}/api_gateway/v1/badges/customer/{customerId}

Path Params

customerId

string

required

Query Params

badgeType

string

enum

Defaults to AVAILABLE

The type of badge to display

Allowed:

includeExpired

boolean

This is the earn expiry. If true then all the earned badges which are even expired will be part of the response. If false, then only the badges where earn is active will be a part of the response

sortOn

string

Enables sorting of badges based on rank. Value: rank.

groupId

string

Badge group ID to which the badge belongs to.

lastEarnedOnDate

float

Date and time when the badge was awarded to the customer. Time format: Epoch format (UNIX timestamp in milliseconds).

lastEarnEventDate

float

Date and time when a triggering event (transactional or behavioural) occurred, initiating the badge earning. Time format: Epoch format (UNIX timestamp in milliseconds).

Headers

X-CAP-CUSTOMER-IDENTIFIER

string

enum

Pass this header to search the customer based on their email, mobile number, card number or external ID.

Allowed:

Response

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