{"openapi":"3.1.0","info":{"title":"GET /api/v1/advisory-firms/{firm_id}/invitations","version":"1.0.0","description":"List pending invitations"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/invitations":{"get":{"tags":["advisory-firms"],"summary":"List pending invitations","description":"List all invitations for a firm, optionally filtered by type (client, staff, or all) and status.","operationId":"list_firm_invitations_api_v1_advisory_firms__firm_id__invitations_get","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm Id"}},{"name":"type","in":"query","required":false,"schema":{"enum":["client","staff","all"],"type":"string","description":"Filter by invitation type","default":"all","title":"Type"},"description":"Filter by invitation type"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status (e.g. pending)","title":"Status"},"description":"Filter by status (e.g. pending)"},{"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/InvitationListResponse"}}}},"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"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InvitationItemResponse":{"properties":{"id":{"type":"string","title":"Id"},"type":{"type":"string","title":"Type","description":"'client' or 'staff'."},"email":{"type":"string","title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"role":{"type":"string","title":"Role"},"status":{"type":"string","title":"Status"},"reason":{"anyOf":[{"type":"string","enum":["clerk_confirmed","new_user","needs_clerk_signup","clerk_unavailable"]},{"type":"null"}],"title":"Reason","description":"Derived at list time for pending invitations — explains why the invite hasn't been accepted yet (new_user / needs_clerk_signup / clerk_unavailable). None for terminal states (accepted / cancelled / expired)."},"firm_id":{"type":"string","title":"Firm Id"},"business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Id","description":"Business ID (client invitations only)."},"invited_by":{"type":"string","title":"Invited By"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"last_sent_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sent At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"business_ids":{"items":{"type":"string"},"type":"array","title":"Business Ids","description":"Businesses queued to be assigned to the invitee on accept (staff member invitations only)."},"assign_all_firm_businesses":{"type":"boolean","title":"Assign All Firm Businesses","description":"If true, the invitee will be assigned to every active firm business on accept (staff member invitations only).","default":false},"team_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Id","description":"Team the invitee will join on accept (staff member invitations only)."}},"type":"object","required":["id","type","email","role","status","firm_id","invited_by","created_at"],"title":"InvitationItemResponse","description":"A single invitation in a list response."},"InvitationListResponse":{"properties":{"invitations":{"items":{"$ref":"#/components/schemas/InvitationItemResponse"},"type":"array","title":"Invitations"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["invitations","total"],"title":"InvitationListResponse","description":"Response schema for listing firm invitations."},"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":[]}]}