API Reference

Listar Clientes

Retornar os dados dos clientes de um grupo.

Log in to see full request history

Listar Clientes

Retorna os dados dos clientes de um grupo específico, podendo se filtrado por data, se o cliente é adimplente ou não e se o mesmo está ativo.

É necessário passar o token do estabelecimento no header "Authorization", e no "Content-Type" preenchê-lo com o valor "application/json".

Abaixo temos um exemplo de como inserir estes dados usando JSON.

{ "Authorization": "Bearer 125SEBXXXXXX20150821", "Content-Type": "application/json" }
Query Params
boolean

Se o cliente está ativo ou não. Ex.: true ou false

boolean

Se o cliente está em débito. Ex.: true ou false

string

Data inicial da busca. Ex.: 2023-01-01

string

Data final da busca. Ex.: 2023-06-01

Headers
string
required

Header no qual o valor é o Token Api do estabelecimento. Ex.: Bearer 125SEBXXXXXX20150821

string
required
Defaults to application/json

Header no qual o valor tem que ser obrigatoriamente "application/json".

Responses

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