{"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","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/SuccessEnvelope_InvitationListResponse_"}}}},"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":"list_firm_invitations_api_v1_advisory_firms__firm_id__invitations_get"}}},"components":{"schemas":{"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","resent"]},{"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"},"email_opened_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Email Opened At","description":"Best-effort: first hit on the tracking pixel embedded in the email."},"email_delivered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Email Delivered At","description":"When SES reported the email as delivered to the recipient's inbox."},"email_bounced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Email Bounced At","description":"When SES reported the email as bounced. Indicates the mailbox is invalid or unreachable."},"email_bounce_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Bounce Reason","description":"Short SES-supplied reason for the bounce, when available."},"email_complaint_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Email Complaint At","description":"When the recipient marked the message as spam."},"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."},"SuccessEnvelope_InvitationListResponse_":{"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/InvitationListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[InvitationListResponse]"},"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":[]}]}