Listar clientes

GET

/api/customers

Autenticação

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:

Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Escopo: customers:read. Retorna métricas agregadas: total gasto (em REAIS), número de transações, primeira/última compra. id é estável (base64url do payerTaxId).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/customers?page=1&limit=20' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "customers": [
    {
      "id": "MTIzNDU2Nzg5MDE",
      "name": "Maria Silva",
      "email": "12345678901",
      "phone": null,
      "totalSpent": 1250.5,
      "transactions": 5,
      "status": "active",
      "firstTransaction": "2026-04-01T09:00:00.000Z",
      "lastTransaction": "2026-05-05T14:30:00.000Z"
    }
  ],
  "stats": {
    "total": 42,
    "active": 28,
    "avgLifetimeValue": 385.75,
    "newThisMonth": 12
  },
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "pages": 3
  }
}

Modificado em 2026-07-02 06:57:27

Página anterior

Clientes

Próxima página

Detalhe de um cliente

Listar clientes

Autenticação#

Requisição

Respostas

Autenticação