These docs are for v2. Click to read the latest docs for v5.

Retornando clientes

Retorna uma lista dos clientes cadastrados

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
Defaults to 10

Retorna n resultados, com um máximo de 1000.

string

Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando x-cursor-nextpage ou x-cursor-previouspage.

string

Retornado nos headers da resposta contém o Token que permite acesso a próxima página.

string

Retornado nos headers da resposta contém o Token que permite acesso a página anterior.

string
Defaults to !DOCUMENT_NUMBER!

Filtro de CPF/CNPJ

string
Defaults to cpf

Filtro de tipo do documento utilizado: cnpj ou cpf

string
Defaults to !NAME!

Filtro pelo nome do cliente

date-time

Filtro pela data de nascimento do cliente no formato de timestamp em milisegundos

string

Filtro pelo sexo do cliente. Pode ser M ou F

date-time
Defaults to !NOW_TIMESTAMP!

Filtro pela data de criação

string

Alias de date_created

string

Filtro pelo id dos customers

Response

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json