Get Points Conversion Schedule

get

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

Retrieves the history of promised points conversion schedules of a customer for a single program or across all programs of the org.

This is a light API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Fetch points conversion schedules of the customer from a specific program. Pass the programId. If not passed, it shows the points balance in the default program.

entityType

string

enum

Pass CUSTOMER to fetch the points conversion schedules of an individual (customer), FLEET to fetch details at the group level. Default value is CUSTOMER.

Allowed:

fetchDataForAllPrograms

boolean

Defaults to false

Pass true to fetch points conversion schedules from all the available programs of the org.

startDate

date

Date (YYYY-MM-DD) from which points conversion schedule details need to be fetched. Minimum supported date - current time + 1 day. Default value - current time.

endDate

date

End date (YYYY-MM-DD) for the points conversion schedule details need to be fetched. Maximum supported date - current time + 100 years (this is the default value).

Headers

X-CAP-API-OAUTH-TOKEN

string

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400