Get the home summary
Home module
GET/home/summaryhome.get
Returns the caller's org dashboard: open and blocked work, projects at risk at their next gate, unread alerts and committed spend as a NULL-aware total. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability home.dashboard.read.
- OAuth scopes: home.
- Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.
Response 200: HomeSummary
| Field | Type | Required | Description |
|---|---|---|---|
| open_work_count | integer | Yes | Records assigned to the caller that are not Complete or Canceled.Constraints: range 0 to any |
| blocked_work_count | integer | Yes | Assigned records that are Blocked.Constraints: range 0 to any |
| projects_at_risk_count | integer | Yes | Projects with an unsatisfied blocking criterion at the next gate.Constraints: range 0 to any |
| alert_count | integer | Yes | Unread alerts.Constraints: range 0 to any |
| committed_spend | MoneyTotal | Yes | A money aggregate that never coerces unpriced inputs to zero. |
{
"open_work_count": 7,
"blocked_work_count": 1,
"projects_at_risk_count": 2,
"alert_count": 3,
"committed_spend": {
"total_minor": 1250000,
"currency": "USD",
"unpriced_count": 2
}
}Code samples
curl -X GET "$XOS_BASE_URL/home/summary" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.home.get();response = xos.home.get()xos home get