Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Point history

Get point transaction history

Get a list of point transactions of the customer.

get/point-history

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 required

The unique ID of the customer. GET /customers

store_idstring

The unique ID of the store in CareCloud. GET /stores

partner_idstring

Unique ID of the partner from the resource GET /partners.

time_fromstring

Start of the time interval for filtering. 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.

time_tostring

End of the time interval for filtering. 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.

point_operation_typestring

Search record by the operation type name or a part of the operation type name.

point_operation_notestring

Search record by the operation note or a part of the operation note.

point_type_idstring

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

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "point_history": [
      {
        "customer_id": "87af991126405bf8e7dfb36045",
        "point_amount": 50,
        "point_operation_type": "Points addition",
        "point_operation_note": "Manual rewards points for the product purchase collection",
        "point_type_id": "81eaeea13b8984a169c490a325",
        "partner_id": "86e05affc7a7abefcd513ab400",
        "store_id": "86e05affc7a7abefcd513ab400",
        "point_history_record_time": "2021-09-16 15:33:11",
        "extended_data": "{\"date_of_points_expiration\": null, \"external_purchase_id\": \"97YDFFGIDF78T0Q3\", \"purchase_value\": 23.5}"
      }
    ],
    "total_items": 1
  }
}