Listar clientes

GET

Markdown (LLM)

Retorna os clientes do estabelecimento.

Escopo:customers:read

Limite:300 requisições a cada 3 minutos.

Parâmetros de query

pageinteger

Página atual da lista.

1

limitinteger

Quantidade de itens por página.

20

sortstring

Ordem da lista: mais recentes (desc) ou mais antigos (asc).

Enum

"desc"

activeboolean

Filtra clientes ativos ou inativos.

true

customerNamestring

Filtra pelos clientes cujo nome contém o texto informado.

"Cliente Exemplo"

emailstring

Filtra pelo e-mail do cliente.

"cliente@exemplo.com"

documentNumberstring

Filtra pelo CPF ou CNPJ exato do cliente (somente dígitos).

"12345678900"

phonestring

Filtra pelos clientes cujo telefone contém os dígitos informados.

"11999990000"

pagenumber

Página atual da lista.

1

limitnumber

Quantidade de itens por página.

2

totalnumber

Total de registros encontrados.

471

pagesnumber

Total de páginas.

236