Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Points Conversion Schedule

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.

get/customers/{userId}/promisedPointsSchedule

Path parameters

userIdstring required

Unique ID of the customer.

Query parameters

IdentifierNamestring

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

IdentifierValuestring

Identifier of the customer specific to the identifierName.

sourcestring

Source on which the identifier is available.

fetchDataForAllProgramsboolean

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

entityType'CUSTOMER' | 'FLEET'

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

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

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

programIdinteger

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-TOKENstring

Response

200

OR
OR

Example response

{
  "entityId": 565039505,
  "entityType": "CUSTOMER"
}