Listar clientes

Todos os clientes ativos da conta, em lista simples.

GET /v1/customers

cURL

curl https://bukio-backend-production.up.railway.app/v1/customers \
  -H "Authorization: Bearer bk_live_..."

200

[
  {
    "id": "0d6c1a7e-5b7f-4f3e-9b2a-1c2d3e4f5a6b",
    "name": "Ana Souza",
    "email": "[e-mail]",
    "phone": "11999998888",
    "document": "12345678900",
    "createdAt": "2026-10-08T15:00:00.000Z",
    "stats": { "paid": 45000, "open": 15000, "count": 4 }
  }
]

Escopo customers:list. Sem cursor. Clientes excluídos não aparecem. E-mail, celular e documento voltam abertos só para a sua conta.

​

Resposta

Uma lista (array) de clientes:

id · string

UUID do cliente.

name · string

Nome.

email · string | null

E-mail.

phone · string | null

Celular, só dígitos.

document · string | null

CPF ou CNPJ, só dígitos.

createdAt · string

Criação.

stats · object

Os números do cliente, somados no servidor com todas as cobranças dele (centavos).

Show campos

paid · integer

Quanto ele já pagou (cobranças pagas, sem as estornadas por inteiro).

open · integer

Quanto está em aberto agora (cobranças aguardando pagamento e ainda no prazo).

count · integer

Quantas cobranças ele tem, em qualquer situação.

cURL

curl https://bukio-backend-production.up.railway.app/v1/customers \
  -H "Authorization: Bearer bk_live_..."

200

[
  {
    "id": "0d6c1a7e-5b7f-4f3e-9b2a-1c2d3e4f5a6b",
    "name": "Ana Souza",
    "email": "[e-mail]",
    "phone": "11999998888",
    "document": "12345678900",
    "createdAt": "2026-10-08T15:00:00.000Z",
    "stats": { "paid": 45000, "open": 15000, "count": 4 }
  }
]