{"openapi":"3.1.0","info":{"title":"GET /api/v1/agents/firm/overview","version":"1.0.0","description":"Every client's team (firm roll-up)"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/agents/firm/overview":{"get":{"tags":["agents"],"summary":"Every client's team (firm roll-up)","description":"One row per business and role across every business the caller can see: status, open runs, what needs a person, cost this month, the last and the next scheduled job; plus a total per business. Members of an advisory firm (and DayZero staff) only.","operationId":"agents_firm_overview","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AgentFirmOverviewResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"agents_firm_overview_api_v1_agents_firm_overview_get"}}},"components":{"schemas":{"AgentFirmOverviewBusiness":{"properties":{"business_id":{"type":"string","title":"Business Id"},"business_name":{"type":"string","title":"Business Name","default":""},"roles":{"type":"integer","title":"Roles","default":0},"open_runs":{"type":"integer","title":"Open Runs","default":0},"needs_you":{"type":"integer","title":"Needs You","default":0},"cost_usd_month":{"type":"string","title":"Cost Usd Month","default":"0"},"next_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Run At"},"next_job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Job Title"}},"type":"object","required":["business_id"],"title":"AgentFirmOverviewBusiness","description":"Per-business totals; a client with no team still has a row (``roles`` 0)."},"AgentFirmOverviewResponse":{"properties":{"month":{"type":"string","title":"Month","description":"YYYY-MM the costs cover (this month)."},"businesses":{"items":{"$ref":"#/components/schemas/AgentFirmOverviewBusiness"},"type":"array","title":"Businesses"},"items":{"items":{"$ref":"#/components/schemas/AgentFirmOverviewRow"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total","default":0}},"type":"object","required":["month"],"title":"AgentFirmOverviewResponse"},"AgentFirmOverviewRow":{"properties":{"business_id":{"type":"string","title":"Business Id"},"business_name":{"type":"string","title":"Business Name","default":""},"role_id":{"type":"string","title":"Role Id"},"role_name":{"type":"string","title":"Role Name"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"status":{"type":"string","enum":["idle","running","needs_you","paused","disabled"],"title":"Status","default":"idle"},"enabled":{"type":"boolean","title":"Enabled","default":true},"paused":{"type":"boolean","title":"Paused","default":false},"open_runs":{"type":"integer","title":"Open Runs","default":0},"needs_you":{"type":"integer","title":"Needs You","default":0},"cost_usd_month":{"type":"string","title":"Cost Usd Month","default":"0"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"next_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Run At"},"next_job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Job Title"},"next_job_href":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Job Href"}},"type":"object","required":["business_id","role_id","role_name"],"title":"AgentFirmOverviewRow","description":"One business × role row of the firm view."},"SuccessEnvelope_AgentFirmOverviewResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/AgentFirmOverviewResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AgentFirmOverviewResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}