---
title: "Filter a list of customers based on the filter parameters. The return can be paginated."
method: POST
path: "/v1/pvt/Customer/list"
tags: ["Customer"]
---

# Filter a list of customers based on the filter parameters. The return can be paginated.

`POST /v1/pvt/Customer/list`

## Request

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

You can get a list of all customers from BonifiQ and their respective points.

## CreatedAtFrom
Use this parameter to filter the list of customers based on the date when they were created inside BonifiQ. 
Increasing this date can help checking every client from BonifiQ inside you system

## Query parameters

- `CreatedAtFrom` string, date-time, nullable
- `Email` string, nullable
- `PageNumber` integer
- `PageSize` integer

## Response `200`

- BaseExternalApiListResponseOfListCustomerResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `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.
    - `PointsBalance` integer: How many points the customer have
  - `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/ListCustomerResponse]/allOf[#/components/schemas/CreateCustomerResponse]/Segments` to the response with the `200` status

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Customer/list/post.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)