Painel do ClientFlow

REST API — Todos os endpoints requerem autenticação via Bearer token. Inclua Authorization: Bearer {token} em cada requisição. Os tokens são gerenciados em Configurações do GitScrum → API. Base URL: https://services.gitscrum.com — Todos os caminhos de requisição nesta documentação são relativos a esta URL base.

Acesse o painel do ClientFlow CRM para pipeline de receita, análise de risco de clientes, saúde de projetos e relatórios entre workspaces.

URL Base: https://services.gitscrum.com

Todos os endpoints requerem o header Authorization: Bearer {token}.

Visão geral do painel

GET /client-flow/dashboard/overview?company_slug={slug}

Retorna a visão geral principal do painel ClientFlow com métricas-chave do CRM.

Resposta

{
  "data": {
    "total_clients": 24,
    "active_projects": 12,
    "revenue_this_month": 45000,
    "pending_invoices": 8,
    "pending_proposals": 3
  }
}

Pipeline de receita

GET /client-flow/dashboard/revenue-pipeline?company_slug={slug}

Retorna o pipeline de receita com detalhamento por status e dados de previsão.

Resposta

{
  "data": {
    "pipeline": {
      "draft": 25000,
      "sent": 85000,
      "approved": 120000,
      "paid": 340000
    },
    "forecast": {
      "next_30_days": 65000,
      "next_90_days": 180000
    }
  }
}

Clientes em risco

GET /client-flow/dashboard/clients-at-risk?company_slug={slug}

Retorna clientes com faturas vencidas, projetos parados ou engajamento em declínio.

Resposta

{
  "data": [
    {
      "client": {
        "uuid": "client-abc-123",
        "name": "Acme Corp"
      },
      "risk_factors": ["overdue_invoice", "stale_project"],
      "overdue_amount": 12000,
      "last_activity": "2026-01-15T10:00:00Z"
    }
  ]
}

Aprovações pendentes

GET /client-flow/dashboard/pending-approvals?company_slug={slug}

Retorna propostas e solicitações de alteração aguardando aprovação.

Saúde dos projetos

GET /client-flow/dashboard/projects-health?company_slug={slug}

Retorna o status de saúde dos projetos voltados ao cliente.

Resposta

{
  "data": [
    {
      "project": {
        "slug": "web-app-redesign",
        "name": "Web App Redesign"
      },
      "health": "at_risk",
      "budget_usage": 92,
      "overdue_tasks": 5,
      "velocity_trend": "declining"
    }
  ]
}

Insights

GET /client-flow/dashboard/insights?company_slug={slug}

Retorna insights gerados por IA sobre relacionamentos com clientes e tendências de receita.

Ranking

GET /client-flow/dashboard/leaderboard?company_slug={slug}

Retorna rankings de desempenho dos membros da equipe para trabalhos com clientes.

Resposta

{
  "data": [
    {
      "username": "johndoe",
      "name": "John Doe",
      "revenue_generated": 85000,
      "tasks_completed": 142,
      "client_satisfaction": 4.8
    }
  ]
}

Análises

GET /client-flow/dashboard/analytics?company_slug={slug}

Retorna análises detalhadas do CRM incluindo tendências, taxas de conversão e métricas de retenção.

Relatórios entre workspaces

Agregam dados de todos os workspaces do usuário autenticado.

Relatórios entre workspaces requerem assinatura Pro.

Faturas

GET /client-flow/all-workspaces/invoices

Retorna relatório de faturas de todos os workspaces.

Propostas

GET /client-flow/all-workspaces/proposals

Retorna propostas de todos os workspaces.

Clientes

GET /client-flow/all-workspaces/clients

Retorna clientes de todos os workspaces.

Solicitações de alteração

GET /client-flow/all-workspaces/change-requests

Retorna solicitações de alteração de todos os workspaces.

Parâmetros de query (todos os endpoints entre workspaces)

Resposta

{
  "data": [],
  "meta": {
    "current_page": 1,
    "per_page": 50,
    "total": 120
  },
  "stats": {
    "total_value": 850000,
    "by_workspace": []
  }
}