Saltar al contenido principal
GET
/
customers
Listar customers
curl --request GET \
  --url https://api.sandbox.z2pay.com/customers \
  --header 'x-api-key: <api-key>'

Autorizaciones

x-api-key
string
header
requerido

API Key da Credential (gerada no Backoffice)

Parámetros de consulta

page
integer
predeterminado:1
Rango requerido: x >= 1
limit
integer
predeterminado:20
Rango requerido: 1 <= x <= 100
name
string | null
email
string | null
document
string | null
documentType
enum<string> | null
Opciones disponibles:
cpf,
cnpj,
passport
phone
string | null
search
string | null
customerSearch
string | null
type
enum<string> | null
Opciones disponibles:
individual,
company
startDate
string<date-time> | null
endDate
string<date-time> | null
sortBy
enum<string> | null
Opciones disponibles:
name,
createdAt,
updatedAt
sortDir
enum<string> | null
Opciones disponibles:
asc,
desc

Respuesta

Lista paginada de customers