Skip to main content

Visão geral

Este endpoint retorna uma lista paginada dos clientes cadastrados na sua conta, com suporte a busca por nome, e-mail ou documento.

Endpoint

Parâmetros de consulta

Busca por nome, e-mail ou documento (CPF/CNPJ) do cliente.
integer
default:"1"
Número da página de resultados.
integer
default:"20"
Quantidade de itens por página. Máximo de 100.

Resposta

array
Lista de objetos de cliente.
object
Informações de paginação, incluindo página atual, total de páginas e total de registros.

Exemplo de resposta

Próximos passos

Criar cliente

Cadastre um novo cliente.

Editar cliente

Atualize os dados de um cliente existente.