API Reference

Listar Clientes por Grupo

Retorna os clientes de um grupo específico.

Log in to see full request history

Listar Clientes por Grupo

Através do Id do grupo ele vai filtrar e retornar um ou mais clientes de acordo com as informações inseridas.

É necessário passar o token gerado no momento em que o usuário realiza o login no header "Authorization".

Abaixo temos um exemplo de como inserir essa informação usando JSON.

{ "Authorization": "eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0" }
Path Params
int32
required

Id do grupo que pertence o estabelecimento. Ex.: 1

Query Params
string
required

Nome do cliente. Ex.: João, Maria, etc.

boolean
required

Se o cliente está ativo ou não. Ex.: True ou False

boolean
required

Se o cliente está em débito ou não. Ex.: True ou False

string
required

Data inicial da criação do cliente. Ex.: 2023-01-01

string
required

Data final da criação do cliente. Ex.: 2023-02-01

Headers
string
required

Token gerado no momento em que o usuário realiza o login no portal. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0

Responses

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