BObonifiq
Customer

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

Changed on

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

post/v1/pvt/Customer/list

Request

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

Query parameters

CreatedAtFromstring date-time nullable
Emailstring nullable
PageNumberinteger

Pagenation number

PageSizeinteger

Amount of items per page, Max size is 50 items per page.

Response

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

  • ab5bc0ffd114Revision changes
    • info

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