Skip to main content
GET
Error

Authorizations

x-api-key
string
header
required

unique identifier access key. each brand has it own unique key.

Query Parameters

limit
number
default:10

pagination: limit of entities returned by query

Required range: x <= 50
cursorId
string

pagination: it is necessary to pass cursorId = null in the first call

status
enum<string>
default:APPROVED
Available options:
PENDING,
APPROVED,
BLOCKED,
INACTIVE
synchronized
enum<string>
Available options:
SUCCESS,
ERROR,
NOT_SYNCHRONIZED,
PROCESSING
code
string

filter by customer code

cpfCnpj
string

filter by CPF or CNPJ

changeStartDate
string

change interval start date

changeEndDate
string

change interval end date

Response

customers pagination

data
object[]
required
nextCursor
string | null

when the field is null, it means that pagination has ended