v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Retrieve points conversion schedule

This API lets you retrieve points conversion schedule of a group.

get/userGroup2/promisedPointsSchedule

Query parameters

primaryUserIdstring

User ID of the member.

startDatestring date

Start date of the date range.

endDatestring date

End date of the date range.

getDataForAllProgramsstring

A boolean parameter to specify if data for all programs is needed.

programIdstring

The ID of the program for which the promised points schedule is requested.

limitstring

The maximum number of records to return per page.

offsetstring

The starting point in the list of records.

Response

200

entityIdinteger
entityTypestring

Example response

{
  "entityId": -21988,
  "entityType": "FLEET",
  "triggerBasedPointsList": [
    {
      "points": 33.33,
      "programId": 1573,
      "pointsType": "line_item_regular"
    }
  ]
}