{"openapi":"3.1.0","info":{"title":"GET /api/v1/advisory-firms/{firm_id}/users/{user_id}/menu","version":"1.0.0","description":"Get a firm staff member's sidebar menu"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/users/{user_id}/menu":{"get":{"tags":["advisory-firms"],"summary":"Get a firm staff member's sidebar menu","description":"The stored sidebar menus for a firm staff member: their firm-wide default plus any per-client overrides. Firm owners/admins can read any member's menu; a member can read their own. The menu that applies on a client resolves business-level first (a direct membership's menu, else the per-client override), then firm-wide, then all sections.","operationId":"get_firm_staff_menu_api_v1_advisory_firms__firm_id__users__user_id__menu_get","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","title":"User Id"}},{"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_FirmStaffMenuDetailResponse_"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"FirmStaffMenuDetailResponse":{"properties":{"user_id":{"type":"string","title":"User Id"},"firm_id":{"type":"string","title":"Firm Id"},"visible_sections":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Visible Sections","description":"Firm-wide default menu. null = all sections."},"menu_enforced":{"type":"boolean","title":"Menu Enforced","description":"Whether a menu binds this member at all. Firm owners/admins manage menus and are never restricted by one.","default":true},"overrides":{"items":{"$ref":"#/components/schemas/FirmStaffMenuOverride"},"type":"array","title":"Overrides"}},"type":"object","required":["user_id","firm_id"],"title":"FirmStaffMenuDetailResponse","description":"A firm staff member's stored sidebar menus.\n\n``visible_sections`` is the firm-wide default (null = all sections);\n``overrides`` lists the clients where a per-client menu replaces it. The\nmenu that applies on a client is resolved business-level first (a direct\nmembership's menu, else the per-client override), then firm-wide, then\nall sections."},"FirmStaffMenuOverride":{"properties":{"business_id":{"type":"string","title":"Business Id"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"visible_sections":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Visible Sections"}},"type":"object","required":["business_id"],"title":"FirmStaffMenuOverride","description":"A per-client menu a firm admin set for one staff member."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_FirmStaffMenuDetailResponse_":{"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/FirmStaffMenuDetailResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[FirmStaffMenuDetailResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}