Listar clientes

get

https://api.trinks.com/v1/clientes

Listar todos os clientes do estabelecimento.

Regras: nome, email, cpf e telefone buscam por trecho, não por valor exato. Em telefone, espaços,
parênteses e hífens são ignorados. dataCadastroFim e dataAlteracaoCadastralFim sem hora incluem o dia
inteiro. Com filtro de alteração cadastral, clientes que nunca foram alterados ficam de fora e
clienteDetalhes vem preenchido.

Paginação: padrão e máximo de 50 por página, em ordem de nome.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

Page

int32

Numeração da página (padrão 1)

PageSize

int32

Quantidade de registros por página (padrão e máximo 50)

Nome

string

Trecho do nome do cliente

CPF

string

Trecho do CPF, só números (Ex: 99999999999)

string

Trecho do e-mail do cliente

Telefone

string

Telefone do cliente (Ex: 21999999999 ou com DDI 5521999999999. Telefones internacionais aceitos também)

DataCadastroInicio

date-time

Data de cadastro inicial (Ex: 2023-07-10T11:57:54 ou 2023-07-10)

DataCadastroFim

date-time

Data de cadastro final. Sem hora, inclui o dia inteiro (Ex: 2023-07-10T11:57:54 ou 2023-07-10)

IncluirDetalhes

boolean

Inclui detalhes do cliente nos resultados apresentados

DataAlteracaoCadastralInicio

date-time

Início pela data da última alteração do cadastro do cliente, que também muda quando outro estabelecimento
altera o mesmo cliente (Ex: 2023-07-10T11:57:54 ou 2023-07-10)

DataAlteracaoCadastralFim

date-time

Fim pela data da última alteração do cadastro. Sem hora, inclui o dia inteiro (Ex: 2023-07-10)

IncluirEtiquetas

boolean

Inclui as etiquetas associadas de cada cliente nos resultados apresentados

Headers

estabelecimentoId

string

required

Response

200Sucesso