{"openapi":"3.1.0","info":{"title":"GET /api/v1/firm/advisory-packs","version":"1.0.0","description":"The firm's advisory pack states"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/firm/advisory-packs":{"get":{"tags":["advisory-packs"],"summary":"The firm's advisory pack states","description":"One row per client the caller can see: the newest pack's month and whether it is a draft or approved, or `none`.","operationId":"get_firm_advisory_packs","parameters":[{"name":"firm_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The firm to read; defaults to the caller's staff firm.","title":"Firm Id"},"description":"The firm to read; defaults to the caller's staff firm."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_FirmAdvisoryOverviewResponse_"}}}},"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":"get_firm_advisory_packs_api_v1_firm_advisory_packs_get"}}},"components":{"schemas":{"FirmAdvisoryOverviewResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FirmAdvisoryRow"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"FirmAdvisoryOverviewResponse"},"FirmAdvisoryRow":{"properties":{"business_id":{"type":"string","title":"Business Id"},"business_name":{"type":"string","title":"Business Name"},"pack_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pack Id"},"period":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period"},"state":{"type":"string","enum":["draft","approved","none"],"title":"State"}},"additionalProperties":false,"type":"object","required":["business_id","business_name","state"],"title":"FirmAdvisoryRow","description":"One client's latest pack, for the firm clients table."},"SuccessEnvelope_FirmAdvisoryOverviewResponse_":{"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/FirmAdvisoryOverviewResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[FirmAdvisoryOverviewResponse]"},"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":[]}]}