Get Customer Tier

get

https://{host}/v2/customers/lookup/tierDetails

Retrieves tier details of a customer for a single program or across all programs of the org.

This is a light API.

Query Params

source

string

enum

required

Source in which the customer identifier is available.

accountId

string

Account in which the customer details are available (Required only for sources with multiple accounts).

identifierName

string

enum

required

Identifier type used for the customer.

Allowed:

identifierValue

string

required

Value of the respective identifier. For example if identifierName is email, then the identifierValue needs to be the email ID of the customer.

programId

int32

Unique ID of the loyalty program from which tier details need to retrieve. If not passed, it shows the points balance in the default program.

entityType

string

enum

Pass CUSTOMER to fetch tier details of the individual, FLEET to fetch details of the user group. Default value is CUSTOMER.

Allowed:

fetchDataForAllPrograms

boolean

Defaults to false

Pass true to fetch tier details from all the available programs of the org. Default value is false.

Headers

X-CAP-API-OAUTH-TOKEN

string

Responses

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

400400