Listar clientes
GET
Os clientes da conta, do mais novo para o mais antigo. Filtre por document para achar um CPF ou CNPJ.
Permissão da chave: customers:read.
header
x-api-key<token>Sua chave de API, criada no painel em Desenvolvedores → Chaves de API.
limit?integerQuantos itens por página (1 a 100).
Faixa
1 <= value <= 100Padrão
20startingAfter?stringO id do último item da página anterior. A página seguinte começa depois dele.
Tamanho
length <= 64document?stringSó o cliente deste CPF ou CNPJ (com ou sem pontuação).
Tamanho
length <= 18Uma página de clientes.
application/json- response
data*array<>hasMore*booleantrue quando há mais itens: peça de novo com startingAfter = o id do último.
curl -X GET "https://example.com/api/v1/customers"{ "data": [ { "id": "cus_01k6g8m2v4x7z9b3c5d7f9h0j2", "name": "Ana Souza", "email": "[email protected]", "phone": "11912345678", "documentType": "CPF", "document": "12345678909", "address": { "zipCode": "01310100", "street": "Avenida Paulista", "number": "1000", "complement": "string", "district": "Bela Vista", "city": "São Paulo", "state": "SP" }, "livemode": true, "createdAt": "2026-10-04T15:30:00.000Z", "updatedAt": "2026-10-04T15:30:00.000Z" } ], "hasMore": true}