v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Points

Get all point records

Get a list of all point transactions and their current values.

get/points

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

customer_idstring

The unique ID of the customer. GET /customers

point_type_idstring

The unique ID of a point type. GET /point-types

create_point_time_fromstring

Start of the time interval for filtering point records by creation time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

create_point_time_tostring

End of the time interval for filtering point records by creation time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

Example response

{
  "data": {
    "points": [
      {
        "point_id": "8bd48117006496e0b1788109b8",
        "customer_id": "87af991126405bf8e7dfb36045",
        "assigned_points": 50,
        "available_points": 700,
        "point_type_id": "81eaeea13b8984a169c490a325",
        "partner_id": "86e05affc7a7abefcd513ab400",
        "valid_to": "2023-09-16 23:59:59",
        "state": 1,
        "created_at": "2016-06-30 15:05:49",
        "note": "Birthdate point reward"
      }
    ],
    "total_items": 1
  }
}