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

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Query Parameters

from
string<date-time> | null

Optional start date for filtering customers by creation date

to
string<date-time> | null

Optional end date for filtering customers by creation date

document
string | null

Optional filter by customer document (CPF/CNPJ)

email
string | null

Optional filter by customer email

originalId
string | null

Optional filter by customer original ID (store ID)

isEnrolled
boolean
default:true

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

pointDateFrom
string<date-time> | null

Optional start date for filtering customers by point event date

pointDateTo
string<date-time> | null

Optional end date for filtering customers by point event date

pageNumber
integer<int32>
default:1

Page number for pagination (default: 1)

pageSize
integer<int32>
default:10

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

Response

200 - application/json

Paginated list of customers with points data

Base List response model methods

Items
object[] | null

Collection with the found entities on the bonifiq DB.

TotalItemCount
integer<int32>

Total of rewards Configurations founds.

PageSize
integer<int32>

Pagination size

PageNumber
integer<int32>

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