---
title: "Retrieves a paginated list of customer points generated on or after a specified date. This endpoint allows for filtering points by a start date and supports pagination. Each item in the list includes detailed point information along with associated customer data."
method: POST
path: "/v1/pvt/Points/list"
tags: ["Points"]
---

# Retrieves a paginated list of customer points generated on or after a specified date. This endpoint allows for filtering points by a start date and supports pagination. Each item in the list includes detailed point information along with associated customer data.

`POST /v1/pvt/Points/list`

## Request

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

## Request body

- ListPointsRequest: Request filter for listing points from a specific date via the external API.
  - `PageNumber` integer: Pagenation number
  - `PageSize` integer: Amount of items per page, Max size is 50 items per page.
  - `DateFrom` string, date-time, nullable: Optional date from which to list points (inclusive). Filters points created or relevant on or after this date. Expected format: ISO 8601 (e.g., "2023-10-27T00:00:00Z" or "2023-10-27").

## Response `200`

- BaseExternalApiResponseOfBaseApiListResultOfApiPointWithCustomerListItem: Standard response envelope used by the External API.
  - `ErrorMessage` string, nullable: Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect `Result`, `Code` and `Severity` first.
  - `ErrorCode` integer, nullable: Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use `ApiResponseErrorDescription`.
  - `Result` BaseApiListResultOfApiPointWithCustomerListItem
    - `Items` object[]
      - `Id` integer
      - `PointId` integer: The unique identifier for the point record.
      - `Points` integer: The number of points.
      - `ReasonType` 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
      - `GenerationDate` string, date-time: The date when the points were generated/awarded.
      - `ExpirationDate` string, date-time, nullable: The date when these points expire, if applicable.
      - `Description` string: Optional description or comments related to the points.
      - `CustomerId` integer: The ID of the customer these points belong to.
      - `CustomerName` string: The name of the customer.
      - `CustomerEmail` string: The email of the customer.
      - `CustomerPhone` string: The phone number of the customer.
      - `CustomerDocument` string: The document number (e.g., CPF) of the customer.
      - `BranchName` string: Name of the branch where the points transaction occurred, if applicable.
      - `BranchId` integer, nullable: ID of the branch where the points transaction occurred, if applicable.
      - `Origin` string: The origin of the order or transaction associated with the points (e.g., WEB, PDV, MANUAL).
      - `CustomerBalance` integer: How much points the customer have
    - `TotalItemCount` integer
    - `PageSize` integer
    - `PageNumber` integer
    - `HasNextPage` boolean
  - `Code` string, nullable: Endpoint-specific business code formatted as a two-digit string, such as `03` or `07`. This field is available for success, warning and error outcomes.
  - `CodeName` string, nullable: Symbolic enum name associated with `Code`, such as `CheckoutNotFound`.
  - `Severity` 0 | 1 | 2: 0 = Success 1 = Warning 2 = Error
  - `HasWarning` boolean: Convenience flag that is `true` when `Severity` is `Warning`. Warnings are valid `200 OK` business outcomes and should not be handled as transport or validation errors.
  - `HasError` boolean: Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as `false`.

---

[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)