BObonifiq
Reports

Returns a list of customers with their points balance, points to expire and point history.

Changed on

This endpoint returns detailed customer information including:

  • Basic customer data (name, email, phone, document)
  • Points balance and cashback balance
  • List of points that will expire soon
  • Complete point transaction history with branch information

By default, only active (enrolled) customers are returned. Use isEnrolled=false to get inactive customers.

You can filter customers by point event date using pointDateFrom and pointDateTo parameters. When these filters are used, only customers who have points within the specified date range will be returned.

You can filter customers by their last update date using updateDateFrom and updateDateTo parameters.

Performance Note: Due to the detailed data returned, pageSize is limited to 10000 items per request.

get/v1/pvt/Reports/ListCustomersReport

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Query parameters

fromstring date-time nullable

Optional start date for filtering customers by creation date

tostring date-time nullable

Optional end date for filtering customers by creation date

documentstring nullable

Optional filter by customer document (CPF/CNPJ)

emailstring nullable

Optional filter by customer email

originalIdstring nullable

Optional filter by customer original ID (store ID)

isEnrolledboolean

Filter by enrolled status (default: true - only active customers)

pointDateFromstring date-time nullable

Optional start date for filtering customers by point event date

pointDateTostring date-time nullable

Optional end date for filtering customers by point event date

pageNumberinteger

Page number for pagination (default: 1)

pageSizeinteger

Number of items per page (default: 10, max: 10000)

updateDateFromstring date-time nullable

Optional start date for filtering customers by last update date

updateDateTostring date-time nullable

Optional end date for filtering customers by last update date

Response

Paginated list of customers with points data

TotalItemCountinteger

Total of rewards Configurations founds.

PageSizeinteger

Pagination size

PageNumberinteger

Actual Page Number

HasNextPageboolean

true if there is another page to be load.

HasErrorboolean

If true the request had an error.

ErrorMessagesstring[]

List with the error messages

Changes

  • f30188727965Revision changes
    • info

      added the optional property ////// to the response with the status

  • 5b1f16130f5bRevision changes
    • info

      added the new optional query request parameter updateDateFrom

    • info

      added the new optional query request parameter updateDateTo