DevelopersAPI reference
Dashboard API
REST endpoints for dashboard in ServFlo: 1 operations with parameters, request and response fields, permissions and curl examples.
Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.
| Operation | Endpoint | Risk |
|---|---|---|
| Dashboard figures | GET /organizations/{organizationId}/dashboard | read |
Dashboard figures
GET /organizations/{organizationId}/dashboard
Counts and money for the dashboard: today's and upcoming jobs, new requests, quotes awaiting approval, outstanding and overdue balances, payments collected this month and tips. Read-only. today is the business's date; it defaults to today in the organization's timezone.
| Permission | reports.read (Owner, Admin, Dispatcher, Member) |
| Risk | read, OAuth scope servflo.read. Read: reads only. |
| MCP tool | dashboard_stats (toolset reports, in the default set) |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
today | query | string | No | A calendar date in the business's own calendar, YYYY-MM-DD. |
Example
curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/dashboard" \
-H "Authorization: Bearer $SERVFLO_API_KEY"Response
200: the answer's fields
| Field | Type | Description |
|---|---|---|
jobs | integer | All jobs. |
customers | integer | |
technicians | integer | Active technicians. |
serviceTypes | integer | |
todayJobs | integer | Visits scheduled today (a job with two visits counts twice). |
upcomingJobs | integer | SCHEDULED or CONFIRMED jobs from today on. |
completedJobs | integer | |
completedRevenueCents | integer | Price of completed jobs, in integer cents. |
invoicesOutstanding | integer | SENT invoices. |
invoicesOutstandingCents | integer | Balance still due on SENT invoices, in integer cents. |
invoicesOverdue | integer | |
invoicesOverdueCents | integer | Balance still due on OVERDUE invoices, in integer cents. |
paymentsCollectedCents | integer | Payments received, net of refunds, tips excluded, in integer cents. |
paymentsThisMonthCents | integer | The same for payments dated this calendar month up to today, in integer cents. |
tipsThisMonthCents | integer | Tips this month, in integer cents. |
requestsNew | integer | NEW requests. |
quotesAwaitingApproval | integer | SENT quotes still within their date. |
activeMembers | integer | ACTIVE memberships. |
membershipMrrCents | integer | Monthly recurring revenue of active memberships, in integer cents. |