Pular para o conteúdo principal
GET
/
customers
Listar customers
curl --request GET \
  --url https://api.sandbox.z2pay.com/customers \
  --header 'x-api-key: <api-key>'

Autorizações

​
x-api-key
string
header
obrigatório

API Key da Credential (gerada no Backoffice)

Parâmetros de consulta

​
page
integer
padrão:1
Intervalo obrigatório: x >= 1
​
limit
integer
padrão:20
Intervalo obrigatório: 1 <= x <= 100
​
name
string | null
​
email
string | null
​
document
string | null
​
documentType
enum<string> | null
Opções disponíveis:
cpf,
cnpj,
passport
​
phone
string | null
​
search
string | null
​
customerSearch
string | null
​
type
enum<string> | null
Opções disponíveis:
individual,
company
​
startDate
string<date-time> | null
​
endDate
string<date-time> | null
​
sortBy
enum<string> | null
Opções disponíveis:
name,
createdAt,
updatedAt
​
sortDir
enum<string> | null
Opções disponíveis:
asc,
desc

Resposta

Lista paginada de customers