Get Points Conversion Schedule

get

https://{host}/v2/customers/{userId}/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…

Path Params

userId

string

required

Unique ID of the customer.

Query Params

IdentifierName

string

Identifier type used to fetch the customer's points conversion schedule details.

IdentifierValue

string

Identifier of the customer specific to the identifierName.

source

string

Source on which the identifier is available.

fetchDataForAllPrograms

boolean

Defaults to false

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

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:

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).

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.

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