---
title: "GET /v1/pvt/Reports/ListPointsAvailableNotification"
method: GET
path: "/v1/pvt/Reports/ListPointsAvailableNotification"
tags: ["Reports"]
---

# GET /v1/pvt/Reports/ListPointsAvailableNotification

`GET /v1/pvt/Reports/ListPointsAvailableNotification`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Reports/ListPointsAvailableNotification`
- Auth: HTTP basic

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Response `200`

- BaseExternalApiListResponseOfReportPointToExpireResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `Id` string: Point unique Id
    - `EventDate` string, date-time: The date the customer earned the points
    - `Points` integer: How many points are going to expire
    - `Cashback` number, nullable: The amount of cashback that will be expired along with the points. It will be null if the cashback is not available.
    - `ExpirationDate` string, date-time, nullable: The date when the points will expire
    - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19: 0 = Purchase 1 = Signup 2 = Birthday 3 = Ordinary 4 = Reward 5 = Review 6 = Refund 7 = Expire 8 = Referral 9 = SocialMediaFollowFacebook 10 = SocialMediaFollowInstagram 11 = PartialOrderRefund 12 = Quiz 13 = CustomObjective 14 = ReferralAffiliate 15 = SocialMediaFollowLinkedin 16 = SocialMediaFollowTikTok 17 = Campaign 18 = Participation 19 = Fitness
    - `Customer` CreateCustomerResponse
      - `OriginalId` string: This is the Id in the client store.
      - `PublicId` string, nullable: Bonifiq Plubic Id
      - `Name` string: Customer name.
      - `Email` string: Customer email.
      - `Phone` string, nullable: Customer Contact Phone.
      - `BirthdayDate` string, date-time, nullable: Customer Birthdate.
      - `SignupDate` string, date-time, nullable: Date when the customer made the register on client store.
      - `Document` string, nullable: Some document number from the customer, accepts any string.
      - `IsEnrolled` boolean: If true the customer is participating on the points plan from the store.
      - `ReferralURL` string, nullable: Customer`s Referral URL. Will be null if the Referral Objective is not active.
      - `WhatsappReferralUrl` string, nullable: Customer`s Referral URL for sharing in Whatsapp. Will be null if Referral Objective is not active
      - `CurrentTier` CustomerTierResponse
        - `Name` string
        - `Color` string
        - `IconUrl` string
      - `BalanceOfPoints` integer: Customer's current points balance
      - `BalanceCashback` number, nullable: Customer's current cashback balance (calculated from points). Will be null if cashback is not enabled.
      - `Segments` object[]: Active customer segments the customer belongs to (name and tag). Inactive segments are not returned. Empty list when the customer is not in any active segment. Populated by the customer endpoints (get, list, create, update, upsert and set birthday).
        - `Name` string: Segment name, as shown in the store's admin panel.
        - `Tag` string: Segment public identifier (slug, unique per store). Use it to reference the segment in integrations.
    - `NotificationDate` string, date-time, nullable: Date when the customer will be notified about the points expiration.
    - `CashbackPercent` number, double, nullable
    - `TotalCashbackAvailable` number, nullable
  - `TotalItemCount` integer: Total of rewards Configurations founds.
  - `PageSize` integer: Pagination size
  - `PageNumber` integer: Actual Page Number
  - `HasNextPage` boolean: true if there is another page to be load.
  - `HasError` boolean: If true the request had an error.
  - `ErrorMessages` string[]: List with the error messages

## Changes

- **2026-09-02** `ab5bc0ffd114`: 1 info
  - added the optional property `Items/items/oneOf[#/components/schemas/ReportPointToExpireResponse]/Customer/oneOf[#/components/schemas/CreateCustomerResponse]/Segments` to the response with the `200` status

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Reports/ListPointsAvailableNotification/get.md)

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)