1. Clientes
Dotfy - Documentação
  • Dotfy Module
    • Raiz
      • Conta (Dados do Seller)
        • Identificar a conta (dados do seller)
      • Cobranças PIX
        • Criar cobrança PIX
        • Listar cobranças
        • Consultar cobrança por correlationID
        • Histórico de webhooks de uma cobrança
      • Saldo
        • Consultar saldo
      • Saques e Chaves PIX
        • Listar chaves PIX cadastradas
        • Cadastrar chave PIX
        • Listar saques
        • Solicitar saque
        • Cancelar saque pendente
      • Clientes
        • Listar clientes
          GET
        • Detalhe de um cliente
          GET
      • Produtos e Links de Pagamento
        • Listar produtos
        • Criar produto
        • Detalhe do produto
        • Carrinhos abandonados do produto
      • Splits
        • Analytics de splits enviados
        • Splits recebidos
      • Disputas e MEDs
        • Listar disputas
        • Listar MEDs com estatísticas
        • Evidências de uma disputa
        • Histórico de uma disputa
      • Webhooks (Gerenciar Endpoints)
        • Listar endpoints
        • Criar endpoint
        • Atualizar endpoint
        • Remover endpoint
      • Webhooks (Eventos Recebidos)
        • EVENT:CHARGE_CREATED — cobrança criada
        • EVENT:CHARGE_PAID — cobrança paga (atualização principal)
        • EVENT:CHARGE_EXPIRED — cobrança expirada
        • EVENT:SPLIT_RECEIVED — você recebeu um split
        • EVENT:DISPUTE_OPENED — MED/disputa aberta
        • EVENT:DISPUTE_WON — disputa ganha
        • EVENT:DISPUTE_LOST — disputa perdida
        • EVENT:DISPUTE_CANCELED — disputa cancelada
        • EVENT:WITHDRAWAL_COMPLETED — saque concluído
        • EVENT:WITHDRAWAL_FAILED — saque falhou
      • Notificações
        • Listar notificações
      • Dashboard / Analytics
        • Stats gerais
        • Atividade recente
        • Atividade (timeline)
        • Receita por período
        • Volume por período
        • Taxa de conversão
        • Métodos de pagamento
        • Transações (gráfico)
        • Analytics avançado
  1. Clientes

Listar clientes

GET
{{base_url}}/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

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{base_url}}/api/customers?page=1&limit=20' \
--header 'Authorization: Bearer {{api_key}}'
Response Response Example
{}
Modificado em 2026-05-07 16:12:35
Página anterior
Clientes
Próxima página
Detalhe de um cliente
Built with