Skip to main content
GET
List Customers

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

page
number
padrão:1
Intervalo obrigatório: x >= 1
limit
number
padrão:10
Intervalo obrigatório: 1 <= x <= 100

Free-text search across customer name, email and document.

document_number
string

Filter by exact customer document number.

email
string

Filter customers by exact email address.

phone
string

Filter customers by phone number.

external_ref
string

Filter customers by your external reference.

status
string

Filter customers by current status.

ip_address
string

Filter customers by last known IP address.

Resposta

Success

success
boolean
obrigatório
requestId
string
obrigatório
metadata
object
obrigatório
data
object[]
obrigatório