GitScrum / Docs

ClientFlow Dashboard

Access the ClientFlow CRM dashboard. Revenue pipeline, clients at risk, project health, and analytics.

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

Access the ClientFlow CRM dashboard for revenue pipeline, client risk analysis, project health, and cross-workspace reports.


Dashboard overview

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

Returns the main ClientFlow dashboard overview with key CRM metrics.

Response

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

Revenue pipeline

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

Returns the revenue pipeline with breakdown by status and forecast data.

Response

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

Clients at risk

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

Returns clients with overdue invoices, stale projects, or declining engagement.

Response

{
  "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"
    }
  ]
}

Pending approvals

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

Returns proposals and change requests awaiting approval.


Projects health

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

Returns health status for client-facing projects.

Response

{
  "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}

Returns AI-generated insights about client relationships and revenue trends.


Leaderboard

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

Returns team member performance rankings for client work.

Response

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

Analytics

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

Returns detailed CRM analytics including trends, conversion rates, and retention metrics.


Cross-workspace reports

Aggregate data across all workspaces owned by the authenticated user.

Cross-workspace reports require a Pro subscription.

Invoices

GET /client-flow/all-workspaces/invoices

Returns invoice report across all workspaces.

Proposals

GET /client-flow/all-workspaces/proposals

Returns proposals across all workspaces.

Clients

GET /client-flow/all-workspaces/clients

Returns clients across all workspaces.

Change requests

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

Returns change requests across all workspaces.

Query parameters (all cross-workspace endpoints)

ParameterTypeDefaultDescription
pageinteger1Page number
per_pageinteger50Results per page (1-100)

Response

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