v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Retrieve points expiry schedule of a group

This API allows you to retrieve the points expiry schedule of a specific group.

get/userGroup2/pointsExpirySchedule

Query parameters

externalIdstring

The external identifier for the user group.

typestring

Type of program

startDatestring

The start date for the points expiry schedule.

endDatestring

The end date for the points expiry schedule.

getDataForAllProgramsboolean

A boolean indicating whether to get data for all programs or not.

fetchEarliestExpiryOnlystring

A boolean indicating whether to fetch only the earliest expiry data.

Response

200

Example response

{
  "expirySchedules": [
    {
      "points": 700,
      "expiryDate": "2024-04-30",
      "programId": 469,
      "pointsType": "bill_regular",
      "expiryType": "fixed"
    }
  ]
}