Skip to main content
GET
Obter clientes

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Query Parameters

id
integer

ID do cliente de que se deseja saber informações, caso seja informado, os demais parâmetros serão ignorados. Caso não seja informado, retornará todos os clientes conforme os limites informados. O limite padrão é 20 e o máximo é 100.

status_cliente
enum<string>

Filtra os clientes pelo status:

A: Ativo I: Inativo S: Suspenso G: Aguardando ativação

Available options:
A,
I,
S,
G
limite
integer
default:20

Quantidade de clientes retornados. O limite padrão é 20 e o máximo é 100.

Required range: x <= 100
pagina
integer
default:1

Qual início da contagem para o limite. O padrão é 1.

ultimo_acesso_apos
string<date-time>

Filtra clientes com último acesso ao app a partir desta data (inclusive). Formato ISO-8601 UTC. É um filtro de segmento: preserva a paginação e é combinável com status_cliente. Exclui clientes com último acesso nulo — para buscar quem nunca acessou o app, use nunca_acessou.

ultimo_acesso_antes_de
string<date-time>

Filtra clientes com último acesso ao app antes desta data (exclusive). Formato ISO-8601 UTC. É um filtro de segmento: preserva a paginação e é combinável com status_cliente. Exclui clientes com último acesso nulo — para buscar quem nunca acessou o app, use nunca_acessou.

nunca_acessou
boolean

Quando true ou 1, retorna somente os clientes que nunca acessaram o app (último acesso nulo).

Response

200 - application/json

Sucesso

The response is of type object.