Listar clientes
Consulte os clientes da sua conta com filtros e paginação por cursor.
Consulta os clientes cadastrados na empresa e no ambiente da sua chave de API. Use os filtros para localizar um cliente pelo identificador, nome, e-mail, CPF/CNPJ ou referência externa do seu sistema.
Comece sem cursor, processe list e, enquanto page.has_next for true,
copie page.next_after para after, mantendo os filtros. Copie o cursor
inteiro, sem interpretar ou calcular seu conteúdo. Consulte
Listagem e paginação para voltar com before.
Veja como os filtros e a ordenação funcionam em Listar clientes.
Parâmetros de consulta
Quantidade de clientes por página. Inteiros positivos acima do máximo usam o máximo. Valor omitido, vazio, zero, negativo ou inválido usa 10.
De 1 a 100
Copie page.next_after da resposta anterior para avançar. Use o cursor sem alterações, mantenha os mesmos filtros e não envie before junto.
Até 128 caracteres
Copie page.previous_before da resposta anterior para voltar uma página. Mantenha os mesmos filtros e não envie after junto.
Até 128 caracteres
Identificador público do cliente, com prefixo cus_.
Até 100 caracteres
Busca pelo nome do cliente, com os cadastros mais recentes primeiro. Deixe vazio para ignorar este filtro.
2 a 120 caracteres
Filtra pelo e-mail completo do cliente.
Até 254 caracteres
Filtra pelo CPF ou CNPJ completo do cliente, com ou sem pontos, barra, hífen e espaços.
Até 20 caracteres
Filtra pela referência atual do cliente no seu sistema, com igualdade do valor completo, incluindo maiúsculas, minúsculas e acentos. Pode ser combinada com os demais filtros. Após criar ou editar o cliente, a busca pode levar alguns segundos para refletir a referência. Mantenha o valor ao navegar por cursor.
Até 120 caracteres
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.