get https://api.zenoti.com/v1/guests//points?view_grooming_points=&page_num=&num_records=&expand[0]=
This API helps you to retrieve the loyalty points history of the specified guest.
You must specify the unique identifier of the guest as guest_id in the API request.
You can also leverage the pagination feature by passing page_num and num_records query parameters if you have a large number of records to be displayed. By default, page_num is set as 1 and num_records is set as 10. num_records cannot be more than 100: which means that the maximum records per page cannot be more than 100.
Response Details
| Name | Type | Description |
|---|---|---|
| guest_points | object | Object that contains all the guest_points-related elements. For more information, refer to the guest_points Object table. |
guest_points Object
| Fields | Type | Description |
|---|---|---|
| balance_points | int | Number of balance points left to be used. |
| balance_amount | int | Balance amount that can be used. |
| exchange_rate | int | Exchange value for points. |
| tier_details | object | Object that contains tier details-related elements. For more information, refer to the tier_details Object table. |
| guest_points_details | List of objects | Object that contains guest points details-related elements. For more information, refer to the guest_points_details Object table. |
tier_details Object
| Field | Type | Description |
|---|---|---|
| name | string | Name of the tier. |
| enrollment_date | datetime | Date and time of the enrolment. |
| amount_to_be_spent_to_stop_downgrade | int | Amount to be spent to in order to stop from getting downgraded. |
guest_points_details Object
| Fields | Type | Description |
|---|---|---|
| invoice_no | string | String that uniquely identifies an invoice. |
| receipt_no | string | String that indicates the receipt number. |
| earned_on | datetime | Date on which the loyalty points were earned. |
| program | string | Name of the program. |
| points_earned | int | Number of total points earned. |
| points_redeemed | int | Number of points redeemed already. |
| balance | int | Number of balance points that can be used. |
| redemption_start | datetime | Date and time from which the redemption began. |
| redemption_end | datetime | Date and time on which the redemption ends. |
| center | string | Name of the center. |
| invoice_id | guid | Unique Identifier of the invoice. |
Note: To retrieve "guest_points_details", you must specify "expand[0]=get_points_history" in the query parameters as illustrated in the example.