{ "components": { "schemas": { "AbuseReviewRequest": { "properties": { "note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "title": "Note" } }, "title": "AbuseReviewRequest", "type": "object" }, "AcceptInviteRequest": { "properties": { "token": { "title": "Token", "type": "string" } }, "required": [ "token" ], "title": "AcceptInviteRequest", "type": "object" }, "ActionCostOut": { "properties": { "action": { "$ref": "#/components/schemas/CreditAction" }, "cost": { "title": "Cost", "type": "integer" }, "name": { "title": "Name", "type": "string" } }, "required": [ "action", "name", "cost" ], "title": "ActionCostOut", "type": "object" }, "ActivityActorOut": { "properties": { "api_key_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Id" }, "api_key_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "kind": { "title": "Kind", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "kind" ], "title": "ActivityActorOut", "type": "object" }, "ActivityEntryOut": { "properties": { "action": { "title": "Action", "type": "string" }, "actor": { "$ref": "#/components/schemas/ActivityActorOut" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip Address" }, "match_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Type" }, "query_params": { "additionalProperties": true, "title": "Query Params", "type": "object" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "result_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Result Count" }, "subject": { "anyOf": [ { "$ref": "#/components/schemas/ActivitySubjectOut" }, { "type": "null" } ] }, "surface": { "title": "Surface", "type": "string" } }, "required": [ "id", "action", "surface", "actor", "query_params", "record_id", "result_count", "match_type", "ip_address", "created_at" ], "title": "ActivityEntryOut", "type": "object" }, "ActivityPageOut": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ActivityEntryOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "scope": { "title": "Scope", "type": "string" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size", "scope" ], "title": "ActivityPageOut", "type": "object" }, "ActivitySubjectOut": { "description": "Who the person behind a view/preview row is, resolved live against the\ndataset (the audit table stores no name snapshot).\n\nMasked exactly like the access it describes: a charged view echoes the\nfull name plus city/state; a preview \u2014 free or zero-credit degraded \u2014\nechoes only the name parts the masked profile revealed, and `city` stays\nnull. `masked` is the machine-readable signal, so a client never has to\ninfer fidelity from the action string.", "properties": { "age": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Age" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "masked": { "title": "Masked", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "required": [ "name", "masked" ], "title": "ActivitySubjectOut", "type": "object" }, "AddExclusionRequest": { "properties": { "kind": { "pattern": "^(organization|email_domain)$", "title": "Kind", "type": "string" }, "note": { "default": "", "maxLength": 512, "title": "Note", "type": "string" }, "value": { "maxLength": 320, "minLength": 1, "title": "Value", "type": "string" } }, "required": [ "kind", "value" ], "title": "AddExclusionRequest", "type": "object" }, "AdminAbuseAlertOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "enforcement": { "title": "Enforcement", "type": "string" }, "evidence": { "additionalProperties": true, "title": "Evidence", "type": "object" }, "hard_blocked": { "title": "Hard Blocked", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "organization_slug": { "title": "Organization Slug", "type": "string" }, "review_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Note" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "signal": { "title": "Signal", "type": "string" }, "soft_blocked_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Soft Blocked Until" }, "status": { "title": "Status", "type": "string" }, "summary": { "title": "Summary", "type": "string" }, "window_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Window End" }, "window_start": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Window Start" } }, "required": [ "id", "organization_id", "organization_name", "organization_slug", "signal", "enforcement", "summary", "evidence", "status", "window_start", "window_end", "soft_blocked_until", "hard_blocked", "reviewed_at", "review_note", "created_at" ], "title": "AdminAbuseAlertOut", "type": "object" }, "AdminAllSearchOut": { "properties": { "action": { "title": "Action", "type": "string" }, "api_key_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Api Key Id" }, "api_key_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Name" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip Address" }, "match_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Type" }, "organization_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Name" }, "query_params": { "additionalProperties": true, "title": "Query Params", "type": "object" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "result_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Result Count" }, "surface": { "title": "Surface", "type": "string" }, "user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Agent" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "record_id", "id", "organization_id", "organization_name", "user_id", "user_email", "user_name", "action", "surface", "api_key_id", "api_key_name", "ip_address", "user_agent", "query_params", "result_count", "created_at" ], "title": "AdminAllSearchOut", "type": "object" }, "AdminAnalyticsOut": { "properties": { "credit_summary": { "$ref": "#/components/schemas/CreditSummaryOut" }, "generations_by_kind": { "items": { "$ref": "#/components/schemas/CategoryCountOut" }, "title": "Generations By Kind", "type": "array" }, "generations_by_status": { "items": { "$ref": "#/components/schemas/CategoryCountOut" }, "title": "Generations By Status", "type": "array" }, "org_signups": { "items": { "$ref": "#/components/schemas/TimeseriesPointOut" }, "title": "Org Signups", "type": "array" }, "pulls_by_action": { "items": { "$ref": "#/components/schemas/CategoryCountOut" }, "title": "Pulls By Action", "type": "array" }, "pulls_by_surface": { "items": { "$ref": "#/components/schemas/CategoryCountOut" }, "title": "Pulls By Surface", "type": "array" }, "pulls_daily": { "items": { "$ref": "#/components/schemas/TimeseriesPointOut" }, "title": "Pulls Daily", "type": "array" }, "top_customers_by_credits": { "items": { "$ref": "#/components/schemas/TopCustomerOut" }, "title": "Top Customers By Credits", "type": "array" }, "top_customers_by_pulls": { "items": { "$ref": "#/components/schemas/TopCustomerOut" }, "title": "Top Customers By Pulls", "type": "array" }, "user_signups": { "items": { "$ref": "#/components/schemas/TimeseriesPointOut" }, "title": "User Signups", "type": "array" } }, "required": [ "user_signups", "org_signups", "pulls_daily", "pulls_by_action", "pulls_by_surface", "generations_by_status", "generations_by_kind", "top_customers_by_pulls", "top_customers_by_credits", "credit_summary" ], "title": "AdminAnalyticsOut", "type": "object" }, "AdminApiKeyHealthOut": { "properties": { "api_key_id": { "format": "uuid", "title": "Api Key Id", "type": "string" }, "api_key_name": { "title": "Api Key Name", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "total_queries": { "title": "Total Queries", "type": "integer" }, "zero_result_queries": { "title": "Zero Result Queries", "type": "integer" } }, "required": [ "api_key_id", "api_key_name", "organization_id", "organization_name", "total_queries", "zero_result_queries", "last_used_at" ], "title": "AdminApiKeyHealthOut", "type": "object" }, "AdminAuditOut": { "properties": { "action": { "title": "Action", "type": "string" }, "actor_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Actor Email" }, "actor_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Actor Name" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "meta": { "additionalProperties": true, "title": "Meta", "type": "object" }, "target_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Target Id" }, "target_type": { "title": "Target Type", "type": "string" } }, "required": [ "id", "actor_email", "actor_name", "action", "target_type", "target_id", "meta", "created_at" ], "title": "AdminAuditOut", "type": "object" }, "AdminCustomerSearchHistoryOut": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminCustomerSearchOut" }, "title": "Items", "type": "array" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "organization_slug": { "title": "Organization Slug", "type": "string" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "organization_id", "organization_name", "organization_slug", "items", "total", "page", "page_size" ], "title": "AdminCustomerSearchHistoryOut", "type": "object" }, "AdminCustomerSearchOut": { "properties": { "action": { "title": "Action", "type": "string" }, "api_key_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Api Key Id" }, "api_key_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Name" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip Address" }, "match_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Type" }, "query_params": { "additionalProperties": true, "title": "Query Params", "type": "object" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "result_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Result Count" }, "surface": { "title": "Surface", "type": "string" }, "user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Agent" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "record_id", "id", "user_id", "user_email", "user_name", "action", "surface", "api_key_id", "api_key_name", "ip_address", "user_agent", "query_params", "result_count", "created_at" ], "title": "AdminCustomerSearchOut", "type": "object" }, "AdminCustomerUsageOut": { "description": "Per-org founder view: who has an account, how many pulls, credits spent.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credit_balance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credit Balance" }, "credits_spent": { "title": "Credits Spent", "type": "integer" }, "dollar_balance_cents": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "readOnly": true, "title": "Dollar Balance Cents" }, "dollars_spent_cents": { "readOnly": true, "title": "Dollars Spent Cents", "type": "integer" }, "last_query_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Query At" }, "member_count": { "title": "Member Count", "type": "integer" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "organization_slug": { "title": "Organization Slug", "type": "string" }, "owner_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Email" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name" }, "pending_holds": { "title": "Pending Holds", "type": "integer" }, "pulls_30d": { "title": "Pulls 30D", "type": "integer" }, "pulls_address_lookup": { "title": "Pulls Address Lookup", "type": "integer" }, "pulls_identity_check": { "title": "Pulls Identity Check", "type": "integer" }, "pulls_prev_30d": { "title": "Pulls Prev 30D", "type": "integer" }, "pulls_search": { "title": "Pulls Search", "type": "integer" }, "pulls_total": { "title": "Pulls Total", "type": "integer" }, "pulls_view": { "title": "Pulls View", "type": "integer" }, "searches_empty": { "title": "Searches Empty", "type": "integer" }, "searches_multi_view": { "title": "Searches Multi View", "type": "integer" }, "searches_no_click": { "title": "Searches No Click", "type": "integer" }, "searches_re_search": { "title": "Searches Re Search", "type": "integer" }, "searches_success": { "title": "Searches Success", "type": "integer" }, "suspended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Suspended At" } }, "required": [ "organization_id", "organization_name", "organization_slug", "created_at", "suspended_at", "member_count", "owner_email", "owner_name", "pulls_total", "pulls_search", "pulls_view", "pulls_address_lookup", "pulls_identity_check", "searches_empty", "searches_no_click", "searches_success", "searches_multi_view", "searches_re_search", "pulls_30d", "pulls_prev_30d", "last_query_at", "credits_spent", "credit_balance", "pending_holds", "dollars_spent_cents", "dollar_balance_cents" ], "title": "AdminCustomerUsageOut", "type": "object" }, "AdminErrorEventOut": { "properties": { "client_ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Ip" }, "code": { "title": "Code", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Detail" }, "error_id": { "title": "Error Id", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "method": { "title": "Method", "type": "string" }, "organization_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Name" }, "path": { "title": "Path", "type": "string" }, "severity": { "title": "Severity", "type": "string" }, "status": { "title": "Status", "type": "integer" }, "title": { "title": "Title", "type": "string" }, "traceback": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Traceback" }, "user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Agent" } }, "required": [ "id", "error_id", "code", "title", "status", "severity", "method", "path", "created_at" ], "title": "AdminErrorEventOut", "type": "object" }, "AdminFailedSearchOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip Address" }, "organization_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Name" }, "query_params": { "additionalProperties": true, "title": "Query Params", "type": "object" }, "surface": { "title": "Surface", "type": "string" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" } }, "required": [ "id", "organization_id", "organization_name", "user_email", "surface", "query_params", "ip_address", "created_at" ], "title": "AdminFailedSearchOut", "type": "object" }, "AdminFeedbackOut": { "properties": { "admin_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Admin Note" }, "app_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "App Version" }, "contact_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Contact Email" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "has_screenshot": { "title": "Has Screenshot", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "message": { "title": "Message", "type": "string" }, "organization_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Name" }, "page_path": { "title": "Page Path", "type": "string" }, "rating": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rating" }, "redacted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Redacted At" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Reviewed At" }, "reviewer_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reviewer Email" }, "source": { "title": "Source", "type": "string" }, "status": { "title": "Status", "type": "string" }, "user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Agent" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "id", "kind", "source", "status", "rating", "message", "contact_email", "page_path", "app_version", "user_agent", "admin_note", "redacted_at", "reviewed_at", "created_at", "user_id", "user_email", "user_name", "organization_id", "organization_name", "reviewer_email", "has_screenshot" ], "title": "AdminFeedbackOut", "type": "object" }, "AdminFeedbackPageOut": { "description": "Page envelope plus the status tallies the queue header shows.", "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminFeedbackOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "status_counts": { "additionalProperties": { "type": "integer" }, "title": "Status Counts", "type": "object" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size", "status_counts" ], "title": "AdminFeedbackPageOut", "type": "object" }, "AdminGenerationOut": { "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credits_cost": { "title": "Credits Cost", "type": "integer" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "kind": { "$ref": "#/components/schemas/CreditAction" }, "model": { "title": "Model", "type": "string" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "prompt": { "title": "Prompt", "type": "string" }, "status": { "$ref": "#/components/schemas/GenerationStatus" }, "user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "required": [ "id", "organization_id", "organization_name", "user_id", "kind", "model", "status", "prompt", "error", "credits_cost", "created_at", "completed_at" ], "title": "AdminGenerationOut", "type": "object" }, "AdminInquirySubjectOut": { "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Of Birth" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "first_seen_at": { "format": "date-time", "title": "First Seen At", "type": "string" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "inquiry_count": { "title": "Inquiry Count", "type": "integer" }, "last_seen_at": { "format": "date-time", "title": "Last Seen At", "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "required": [ "id", "full_name", "date_of_birth", "city", "state", "email", "phone", "inquiry_count", "first_seen_at", "last_seen_at" ], "title": "AdminInquirySubjectOut", "type": "object" }, "AdminInvitationOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "invited_by_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invited By Email" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "role": { "$ref": "#/components/schemas/Role" } }, "required": [ "id", "organization_id", "organization_name", "email", "role", "invited_by_email", "expires_at", "created_at" ], "title": "AdminInvitationOut", "type": "object" }, "AdminMetricsOut": { "properties": { "latest_snapshot_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Latest Snapshot Date" }, "series": { "additionalProperties": { "items": { "$ref": "#/components/schemas/MetricPointOut" }, "type": "array" }, "title": "Series", "type": "object" }, "stale": { "title": "Stale", "type": "boolean" }, "summary": { "items": { "$ref": "#/components/schemas/MetricSummaryOut" }, "title": "Summary", "type": "array" } }, "required": [ "series", "summary", "latest_snapshot_date", "stale" ], "title": "AdminMetricsOut", "type": "object" }, "AdminOrgMemberOut": { "properties": { "email": { "title": "Email", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "joined_at": { "format": "date-time", "title": "Joined At", "type": "string" }, "name": { "title": "Name", "type": "string" }, "role": { "$ref": "#/components/schemas/Role" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" } }, "required": [ "user_id", "email", "name", "role", "is_active", "joined_at" ], "title": "AdminOrgMemberOut", "type": "object" }, "AdminOrgOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "member_count": { "title": "Member Count", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "owner_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Email" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Name" }, "records_block_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Records Block Reason" }, "records_hard_blocked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Records Hard Blocked At" }, "records_soft_blocked_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Records Soft Blocked Until" }, "slug": { "title": "Slug", "type": "string" }, "suspended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Suspended At" } }, "required": [ "id", "name", "slug", "created_at", "suspended_at", "member_count" ], "title": "AdminOrgOut", "type": "object" }, "AdminOrgRecordsBlockOut": { "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "records_block_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Records Block Reason" }, "records_hard_blocked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Records Hard Blocked At" }, "records_soft_blocked_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Records Soft Blocked Until" } }, "required": [ "id", "records_soft_blocked_until", "records_hard_blocked_at", "records_block_reason" ], "title": "AdminOrgRecordsBlockOut", "type": "object" }, "AdminOrgSuspensionOut": { "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "suspended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Suspended At" } }, "required": [ "id", "suspended_at" ], "title": "AdminOrgSuspensionOut", "type": "object" }, "AdminRecordSubjectOut": { "description": "Who the person behind an audited record id is.\n\nThe audit trail deliberately stores no name snapshot (see\nrecords/application/audit_logging.py), so the query-history views resolve\nsubjects live against the dataset. Superuser-only, like the replay route.", "properties": { "age": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Age" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "deceased": { "title": "Deceased", "type": "boolean" }, "full_name": { "title": "Full Name", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" } }, "required": [ "record_id", "full_name", "age", "deceased", "city", "state", "zip" ], "title": "AdminRecordSubjectOut", "type": "object" }, "AdminRecordSubjectsOut": { "description": "Subjects for the requested ids. Ids that resolve to nothing (unknown,\ntampered, or suppressed) are omitted rather than returned as nulls.", "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminRecordSubjectOut" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "AdminRecordSubjectsOut", "type": "object" }, "AdminSearchApiKeyOut": { "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "key_prefix": { "title": "Key Prefix", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "title": "Name", "type": "string" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "revoked": { "title": "Revoked", "type": "boolean" } }, "required": [ "id", "name", "key_prefix", "organization_id", "organization_name", "revoked", "last_used_at" ], "title": "AdminSearchApiKeyOut", "type": "object" }, "AdminSearchOrgOut": { "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "suspended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Suspended At" } }, "required": [ "id", "name", "slug", "suspended_at" ], "title": "AdminSearchOrgOut", "type": "object" }, "AdminSearchOut": { "properties": { "api_keys": { "items": { "$ref": "#/components/schemas/AdminSearchApiKeyOut" }, "title": "Api Keys", "type": "array" }, "organizations": { "items": { "$ref": "#/components/schemas/AdminSearchOrgOut" }, "title": "Organizations", "type": "array" }, "q": { "title": "Q", "type": "string" }, "users": { "items": { "$ref": "#/components/schemas/AdminSearchUserOut" }, "title": "Users", "type": "array" } }, "required": [ "q", "users", "organizations", "api_keys" ], "title": "AdminSearchOut", "type": "object" }, "AdminSearchResultOut": { "description": "Compact replay row for platform admins.\n\nPublic/customer search summaries intentionally mask contact fields. This\nadmin route is superuser-only, so it returns primary email/phone in full\nwhile still exposing only the public GD record id.", "properties": { "age": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Age" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "deceased": { "title": "Deceased", "type": "boolean" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "full_name": { "title": "Full Name", "type": "string" }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender" }, "id": { "title": "Id", "type": "string" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "match_confidence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Match Confidence" }, "match_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Tier" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" } }, "required": [ "id", "full_name", "first_name", "last_name", "gender", "age", "deceased", "city", "state", "zip", "email", "phone" ], "title": "AdminSearchResultOut", "type": "object" }, "AdminSearchResultsOut": { "description": "Re-played search results for admin inspection (no credit charge).\n\nItems are an admin-only compact record shape with primary contact fields\nunmasked. Only `search` action queries are eligible.", "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminSearchResultOut" }, "title": "Items", "type": "array" }, "match_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Type" }, "search_id": { "format": "uuid", "title": "Search Id", "type": "string" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "search_id", "items", "total" ], "title": "AdminSearchResultsOut", "type": "object" }, "AdminSearchUserOut": { "properties": { "email": { "title": "Email", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_superuser": { "title": "Is Superuser", "type": "boolean" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "email", "name", "is_active", "is_superuser" ], "title": "AdminSearchUserOut", "type": "object" }, "AdminStats": { "properties": { "active_users": { "title": "Active Users", "type": "integer" }, "total_organizations": { "title": "Total Organizations", "type": "integer" }, "total_users": { "title": "Total Users", "type": "integer" } }, "required": [ "total_users", "active_users", "total_organizations" ], "title": "AdminStats", "type": "object" }, "AdminUserOrgBriefOut": { "description": "Just enough of an organization to name it on the Users table row.", "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "role": { "$ref": "#/components/schemas/Role" }, "slug": { "title": "Slug", "type": "string" }, "suspended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Suspended At" } }, "required": [ "id", "name", "slug", "role", "suspended_at" ], "title": "AdminUserOrgBriefOut", "type": "object" }, "AdminUserOrgOut": { "description": "One organization a user belongs to, with their role and credit wallet.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credit_balance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credit Balance" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "pending_holds": { "default": 0, "title": "Pending Holds", "type": "integer" }, "role": { "$ref": "#/components/schemas/Role" }, "slug": { "title": "Slug", "type": "string" }, "suspended_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Suspended At" } }, "required": [ "id", "name", "slug", "role", "suspended_at", "created_at" ], "title": "AdminUserOrgOut", "type": "object" }, "AdminUserOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credit_balance": { "default": 0, "title": "Credit Balance", "type": "integer" }, "email": { "title": "Email", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "is_superuser": { "title": "Is Superuser", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "organization_count": { "title": "Organization Count", "type": "integer" }, "organizations": { "default": [], "items": { "$ref": "#/components/schemas/AdminUserOrgBriefOut" }, "title": "Organizations", "type": "array" }, "pending_holds": { "default": 0, "title": "Pending Holds", "type": "integer" } }, "required": [ "id", "email", "name", "is_active", "is_superuser", "created_at", "organization_count" ], "title": "AdminUserOut", "type": "object" }, "AdminWalletOut": { "properties": { "allowance_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Allowance Period" }, "balance": { "title": "Balance", "type": "integer" }, "organization_id": { "format": "uuid", "title": "Organization Id", "type": "string" }, "organization_name": { "title": "Organization Name", "type": "string" }, "pending_holds": { "title": "Pending Holds", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "organization_id", "organization_name", "balance", "allowance_period", "pending_holds", "updated_at" ], "title": "AdminWalletOut", "type": "object" }, "AlertRuleOut": { "description": "The admin-notification side: new submissions -> email to the team.", "properties": { "check_every_minutes": { "title": "Check Every Minutes", "type": "integer" }, "key": { "title": "Key", "type": "string" }, "last_fired_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Fired At" }, "notified_through": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Notified Through" }, "recipient_count": { "title": "Recipient Count", "type": "integer" } }, "required": [ "key", "check_every_minutes", "recipient_count", "last_fired_at", "notified_through" ], "title": "AlertRuleOut", "type": "object" }, "ApiKeyCreate": { "properties": { "name": { "maxLength": 120, "minLength": 1, "title": "Name", "type": "string" }, "permitted_use_accepted": { "title": "Permitted Use Accepted", "type": "boolean" } }, "required": [ "name", "permitted_use_accepted" ], "title": "ApiKeyCreate", "type": "object" }, "ApiKeyCreated": { "description": "Returned exactly once at creation \u2014 includes the full raw key.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "key_prefix": { "title": "Key Prefix", "type": "string" }, "name": { "title": "Name", "type": "string" }, "raw_key": { "title": "Raw Key", "type": "string" } }, "required": [ "id", "name", "key_prefix", "created_at", "raw_key" ], "title": "ApiKeyCreated", "type": "object" }, "ApiKeyOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "key_prefix": { "title": "Key Prefix", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name", "key_prefix", "created_at" ], "title": "ApiKeyOut", "type": "object" }, "BillingAccountOut": { "properties": { "has_billing_account": { "title": "Has Billing Account", "type": "boolean" } }, "required": [ "has_billing_account" ], "title": "BillingAccountOut", "type": "object" }, "CaseOut": { "properties": { "confidence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Confidence" }, "consumer_key": { "title": "Consumer Key", "type": "string" }, "label": { "title": "Label", "type": "string" }, "n_results": { "title": "N Results", "type": "integer" }, "passed": { "title": "Passed", "type": "boolean" }, "polarity": { "title": "Polarity", "type": "string" }, "shape": { "title": "Shape", "type": "string" }, "tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tier" } }, "required": [ "consumer_key", "label", "shape", "polarity", "passed", "confidence", "tier", "n_results" ], "title": "CaseOut", "type": "object" }, "CategoryCountOut": { "properties": { "count": { "title": "Count", "type": "integer" }, "label": { "title": "Label", "type": "string" } }, "required": [ "label", "count" ], "title": "CategoryCountOut", "type": "object" }, "ChangePasswordRequest": { "properties": { "current_password": { "title": "Current Password", "type": "string" }, "password": { "maxLength": 128, "title": "Password", "type": "string" }, "password_confirmation": { "maxLength": 128, "title": "Password Confirmation", "type": "string" } }, "required": [ "current_password", "password", "password_confirmation" ], "title": "ChangePasswordRequest", "type": "object" }, "CloseIn": { "properties": { "notes": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "title": "CloseIn", "type": "object" }, "CompleteRequest": { "properties": { "max_tokens": { "default": 1024, "maximum": 8192.0, "minimum": 1.0, "title": "Max Tokens", "type": "integer" }, "prompt": { "maxLength": 8000, "minLength": 1, "title": "Prompt", "type": "string" }, "provider": { "$ref": "#/components/schemas/LlmProvider" } }, "required": [ "provider", "prompt" ], "title": "CompleteRequest", "type": "object" }, "ConsentIn": { "properties": { "analytics": { "title": "Analytics", "type": "boolean" }, "policy_version": { "maxLength": 32, "minLength": 1, "title": "Policy Version", "type": "string" } }, "required": [ "analytics", "policy_version" ], "title": "ConsentIn", "type": "object" }, "ConsentOut": { "properties": { "analytics": { "title": "Analytics", "type": "boolean" }, "policy_version": { "title": "Policy Version", "type": "string" }, "recorded_at": { "format": "date-time", "title": "Recorded At", "type": "string" } }, "required": [ "analytics", "policy_version", "recorded_at" ], "title": "ConsentOut", "type": "object" }, "CoverageOut": { "properties": { "county_count": { "title": "County Count", "type": "integer" }, "fips_codes": { "items": { "type": "string" }, "title": "Fips Codes", "type": "array" } }, "required": [ "fips_codes", "county_count" ], "title": "CoverageOut", "type": "object" }, "CreateGenerationRequest": { "properties": { "kind": { "$ref": "#/components/schemas/CreditAction" }, "prompt": { "maxLength": 4000, "minLength": 1, "title": "Prompt", "type": "string" } }, "required": [ "kind", "prompt" ], "title": "CreateGenerationRequest", "type": "object" }, "CreateRunIn": { "properties": { "floor": { "default": 50, "maximum": 100.0, "minimum": 0.0, "title": "Floor", "type": "integer" }, "sample_size": { "default": 500, "maximum": 2000.0, "minimum": 1.0, "title": "Sample Size", "type": "integer" } }, "title": "CreateRunIn", "type": "object" }, "CreditAction": { "description": "Metered actions a reservation can be opened for.", "enum": [ "image_nano_banana", "image_gpt", "video_veo", "llm_call", "record_search", "record_view", "record_address_lookup", "property_lookup", "property_address_search" ], "title": "CreditAction", "type": "string" }, "CreditAdjustRequest": { "properties": { "amount": { "maximum": 1000000.0, "minimum": -1000000.0, "title": "Amount", "type": "integer" }, "description": { "maxLength": 255, "minLength": 1, "title": "Description", "type": "string" } }, "required": [ "amount", "description" ], "title": "CreditAdjustRequest", "type": "object" }, "CreditPack": { "description": "One-time top-up packs purchasable via Stripe (mode=payment).", "enum": [ "starter", "growth", "scale", "bulk" ], "title": "CreditPack", "type": "string" }, "CreditPackCheckoutRequest": { "properties": { "pack": { "$ref": "#/components/schemas/CreditPack" }, "return_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Return To" } }, "required": [ "pack" ], "title": "CreditPackCheckoutRequest", "type": "object" }, "CreditPackOut": { "properties": { "credits": { "title": "Credits", "type": "integer" }, "discount_pct": { "title": "Discount Pct", "type": "integer" }, "name": { "title": "Name", "type": "string" }, "pack": { "$ref": "#/components/schemas/CreditPack" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "purchasable": { "title": "Purchasable", "type": "boolean" }, "unit_price_cents": { "title": "Unit Price Cents", "type": "integer" } }, "required": [ "pack", "name", "credits", "price_cents", "unit_price_cents", "discount_pct", "purchasable" ], "title": "CreditPackOut", "type": "object" }, "CreditSummaryOut": { "properties": { "total_balance": { "title": "Total Balance", "type": "integer" }, "total_credits_captured": { "title": "Total Credits Captured", "type": "integer" }, "total_pending_holds": { "title": "Total Pending Holds", "type": "integer" } }, "required": [ "total_balance", "total_pending_holds", "total_credits_captured" ], "title": "CreditSummaryOut", "type": "object" }, "DatasetHealthOut": { "properties": { "dataset": { "anyOf": [ { "$ref": "#/components/schemas/DatasetInfoOut" }, { "type": "null" } ] }, "metrics": { "items": { "$ref": "#/components/schemas/QueryWindowMetricsOut" }, "title": "Metrics", "type": "array" }, "records_backend": { "title": "Records Backend", "type": "string" }, "sources": { "items": { "$ref": "#/components/schemas/DatasetSourceOut" }, "title": "Sources", "type": "array" }, "volume_daily_7d": { "items": { "$ref": "#/components/schemas/TimeseriesPointOut" }, "title": "Volume Daily 7D", "type": "array" }, "volume_hourly_24h": { "items": { "$ref": "#/components/schemas/TimeseriesPointOut" }, "title": "Volume Hourly 24H", "type": "array" } }, "required": [ "records_backend", "dataset", "sources", "metrics", "volume_hourly_24h", "volume_daily_7d" ], "title": "DatasetHealthOut", "type": "object" }, "DatasetInfoOut": { "properties": { "age_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Age Days" }, "exists": { "title": "Exists", "type": "boolean" }, "last_modified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Modified At" }, "manifest": { "anyOf": [ { "$ref": "#/components/schemas/DatasetManifestOut" }, { "type": "null" } ] }, "path": { "title": "Path", "type": "string" }, "tables": { "items": { "$ref": "#/components/schemas/DatasetTableOut" }, "title": "Tables", "type": "array" } }, "required": [ "path", "exists", "last_modified_at", "age_days", "manifest", "tables" ], "title": "DatasetInfoOut", "type": "object" }, "DatasetManifestOut": { "properties": { "built_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Built At" }, "row_counts": { "additionalProperties": { "type": "integer" }, "title": "Row Counts", "type": "object" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, "required": [ "version", "built_at", "source", "row_counts" ], "title": "DatasetManifestOut", "type": "object" }, "DatasetSourceDetailOut": { "properties": { "columns": { "items": { "$ref": "#/components/schemas/SourceColumnOut" }, "title": "Columns", "type": "array" }, "source": { "$ref": "#/components/schemas/DatasetSourceOut" } }, "required": [ "source", "columns" ], "title": "DatasetSourceDetailOut", "type": "object" }, "DatasetSourceOut": { "description": "An upstream vendor delivery the dataset is built from \u2014 size/shape as\nreceived, plus whether it is combined into the serving build.", "properties": { "columns": { "title": "Columns", "type": "integer" }, "coverage": { "title": "Coverage", "type": "string" }, "delivery": { "title": "Delivery", "type": "string" }, "derived_tables": { "items": { "type": "string" }, "title": "Derived Tables", "type": "array" }, "grain": { "title": "Grain", "type": "string" }, "join_key": { "title": "Join Key", "type": "string" }, "key": { "title": "Key", "type": "string" }, "label": { "title": "Label", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "raw_bytes": { "title": "Raw Bytes", "type": "integer" }, "raw_files": { "title": "Raw Files", "type": "integer" }, "raw_rows": { "title": "Raw Rows", "type": "integer" }, "role": { "title": "Role", "type": "string" }, "status": { "title": "Status", "type": "string" }, "vendor": { "title": "Vendor", "type": "string" } }, "required": [ "key", "label", "vendor", "delivery", "role", "status", "raw_files", "raw_bytes", "raw_rows", "columns", "grain", "join_key", "coverage", "derived_tables", "notes" ], "title": "DatasetSourceOut", "type": "object" }, "DatasetTableOut": { "properties": { "last_modified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Modified At" }, "layout": { "title": "Layout", "type": "string" }, "name": { "title": "Name", "type": "string" }, "partition_count": { "title": "Partition Count", "type": "integer" }, "symlink_target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Symlink Target" } }, "required": [ "name", "layout", "partition_count", "symlink_target", "last_modified_at" ], "title": "DatasetTableOut", "type": "object" }, "ErrorCodeCountOut": { "properties": { "code": { "title": "Code", "type": "string" }, "count": { "title": "Count", "type": "integer" }, "last_seen_at": { "format": "date-time", "title": "Last Seen At", "type": "string" }, "severity": { "title": "Severity", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "code", "title", "severity", "count", "last_seen_at" ], "title": "ErrorCodeCountOut", "type": "object" }, "ErrorEventSummaryOut": { "properties": { "by_code": { "items": { "$ref": "#/components/schemas/ErrorCodeCountOut" }, "title": "By Code", "type": "array" }, "by_severity": { "items": { "$ref": "#/components/schemas/CategoryCountOut" }, "title": "By Severity", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "total", "by_code", "by_severity" ], "title": "ErrorEventSummaryOut", "type": "object" }, "FeedbackAutomationOut": { "properties": { "alert": { "$ref": "#/components/schemas/AlertRuleOut" }, "prompt": { "$ref": "#/components/schemas/PromptRuleOut" } }, "required": [ "prompt", "alert" ], "title": "FeedbackAutomationOut", "type": "object" }, "FeedbackIn": { "properties": { "app_version": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "title": "App Version" }, "kind": { "$ref": "#/components/schemas/FeedbackKind" }, "message": { "maxLength": 4000, "minLength": 3, "title": "Message", "type": "string" }, "organization_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" }, "page_path": { "default": "", "maxLength": 200, "title": "Page Path", "type": "string" }, "rating": { "anyOf": [ { "maximum": 5.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Rating" }, "screenshot": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Screenshot" }, "screenshot_mime": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Screenshot Mime" }, "source": { "$ref": "#/components/schemas/FeedbackSource" } }, "required": [ "kind", "source", "message" ], "title": "FeedbackIn", "type": "object" }, "FeedbackKind": { "description": "What the user is telling us. Keep stable \u2014 used in admin filters.", "enum": [ "bug", "idea", "praise", "other" ], "title": "FeedbackKind", "type": "string" }, "FeedbackOut": { "description": "Deliberately does not echo `message` \u2014 nothing needs it back.", "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "kind": { "$ref": "#/components/schemas/FeedbackKind" }, "rating": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rating" } }, "required": [ "id", "kind", "rating", "created_at" ], "title": "FeedbackOut", "type": "object" }, "FeedbackPromptIn": { "properties": { "state": { "$ref": "#/components/schemas/PromptState" } }, "required": [ "state" ], "title": "FeedbackPromptIn", "type": "object" }, "FeedbackPromptOut": { "properties": { "action_threshold": { "title": "Action Threshold", "type": "integer" }, "ask_count": { "title": "Ask Count", "type": "integer" }, "eligible": { "title": "Eligible", "type": "boolean" }, "snooze_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Snooze Until" }, "state": { "anyOf": [ { "$ref": "#/components/schemas/PromptState" }, { "type": "null" } ] } }, "required": [ "state", "eligible", "ask_count", "action_threshold", "snooze_until" ], "title": "FeedbackPromptOut", "type": "object" }, "FeedbackSource": { "description": "Which entry point produced the row \u2014 tells us what actually gets used.", "enum": [ "inline", "bubble", "prompt" ], "title": "FeedbackSource", "type": "string" }, "FeedbackStatus": { "enum": [ "new", "triaged", "closed" ], "title": "FeedbackStatus", "type": "string" }, "FeedbackUpdateIn": { "properties": { "admin_note": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "title": "Admin Note" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/FeedbackStatus" }, { "type": "null" } ] } }, "title": "FeedbackUpdateIn", "type": "object" }, "ForgotPasswordRequest": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" } }, "required": [ "email" ], "title": "ForgotPasswordRequest", "type": "object" }, "ForwardIn": { "properties": { "notes": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "title": "Notes" }, "provider_reference": { "maxLength": 128, "minLength": 1, "title": "Provider Reference", "type": "string" } }, "required": [ "provider_reference" ], "title": "ForwardIn", "type": "object" }, "FulfillIn": { "properties": { "also_forward": { "default": true, "title": "Also Forward", "type": "boolean" }, "notes": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "null" } ], "title": "Notes" }, "provider_reference": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Provider Reference" } }, "title": "FulfillIn", "type": "object" }, "FulfillOut": { "properties": { "matches": { "items": { "$ref": "#/components/schemas/SubjectMatchOut" }, "title": "Matches", "type": "array" }, "request": { "$ref": "#/components/schemas/PrivacyRequestOut" } }, "required": [ "request", "matches" ], "title": "FulfillOut", "type": "object" }, "GenerationFailureGroupOut": { "properties": { "count": { "title": "Count", "type": "integer" }, "error_sample": { "title": "Error Sample", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "last_failed_at": { "format": "date-time", "title": "Last Failed At", "type": "string" }, "model": { "title": "Model", "type": "string" } }, "required": [ "kind", "model", "error_sample", "count", "last_failed_at" ], "title": "GenerationFailureGroupOut", "type": "object" }, "GenerationFailureSummaryOut": { "properties": { "by_group": { "items": { "$ref": "#/components/schemas/GenerationFailureGroupOut" }, "title": "By Group", "type": "array" }, "failure_rate": { "title": "Failure Rate", "type": "number" }, "total_failed": { "title": "Total Failed", "type": "integer" }, "total_succeeded": { "title": "Total Succeeded", "type": "integer" } }, "required": [ "total_failed", "total_succeeded", "failure_rate", "by_group" ], "title": "GenerationFailureSummaryOut", "type": "object" }, "GenerationOut": { "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credits_cost": { "title": "Credits Cost", "type": "integer" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "has_file": { "title": "Has File", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "kind": { "$ref": "#/components/schemas/CreditAction" }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime Type" }, "model": { "title": "Model", "type": "string" }, "prompt": { "title": "Prompt", "type": "string" }, "status": { "$ref": "#/components/schemas/GenerationStatus" } }, "required": [ "id", "kind", "model", "prompt", "status", "credits_cost", "mime_type", "error", "has_file", "created_at", "completed_at" ], "title": "GenerationOut", "type": "object" }, "GenerationStatus": { "enum": [ "pending", "succeeded", "failed", "canceled" ], "title": "GenerationStatus", "type": "string" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "HistoryOut": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TransactionOut" }, "title": "Items", "type": "array" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total" ], "title": "HistoryOut", "type": "object" }, "HouseholdMemberOut": { "description": "Person linked to the queried address \u2014 contact fields masked.", "properties": { "age": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Age" }, "deceased": { "title": "Deceased", "type": "boolean" }, "email_masked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Masked" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "full_name": { "title": "Full Name", "type": "string" }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender" }, "id": { "title": "Id", "type": "string" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "matched_address": { "$ref": "#/components/schemas/MatchedAddressOut" }, "phone_masked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Masked" }, "residency": { "title": "Residency", "type": "string" } }, "required": [ "id", "full_name", "first_name", "last_name", "gender", "age", "deceased", "residency", "matched_address", "email_masked", "phone_masked" ], "title": "HouseholdMemberOut", "type": "object" }, "HouseholdPageOut": { "properties": { "address_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address Key" }, "current_count": { "default": 0, "title": "Current Count", "type": "integer" }, "has_more": { "title": "Has More", "type": "boolean" }, "historical_count": { "default": 0, "title": "Historical Count", "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/HouseholdMemberOut" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" } }, "required": [ "items", "has_more", "limit", "offset" ], "title": "HouseholdPageOut", "type": "object" }, "IdentityCheckIn": { "description": "Submitted attributes for a Match / No match / Needs review check.\n\nProvide email and/or phone (at least one required by policy).", "properties": { "city": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "City" }, "date_of_birth": { "maxLength": 32, "minLength": 4, "title": "Date Of Birth", "type": "string" }, "email": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Email" }, "full_name": { "maxLength": 256, "minLength": 1, "title": "Full Name", "type": "string" }, "phone": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Phone" }, "state": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "State" }, "zip": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Zip" } }, "required": [ "full_name", "date_of_birth" ], "title": "IdentityCheckIn", "type": "object" }, "IdentityCheckOut": { "description": "Authenticated check \u2014 outcome plus a masked teaser and record id.", "properties": { "match_confidence": { "title": "Match Confidence", "type": "integer" }, "outcome": { "title": "Outcome", "type": "string" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "score": { "title": "Score", "type": "integer" }, "signals": { "default": [], "items": { "type": "string" }, "title": "Signals", "type": "array" }, "teaser": { "anyOf": [ { "$ref": "#/components/schemas/RecordSummaryOut" }, { "type": "null" } ] } }, "required": [ "outcome", "match_confidence", "score" ], "title": "IdentityCheckOut", "type": "object" }, "IdentityCheckPublicOut": { "description": "Coarse public result \u2014 no PII, signup gate for the full record.", "properties": { "match_confidence": { "title": "Match Confidence", "type": "integer" }, "outcome": { "title": "Outcome", "type": "string" }, "score": { "title": "Score", "type": "integer" }, "signals": { "default": [], "items": { "type": "string" }, "title": "Signals", "type": "array" }, "signup_required": { "default": true, "title": "Signup Required", "type": "boolean" } }, "required": [ "outcome", "match_confidence", "score" ], "title": "IdentityCheckPublicOut", "type": "object" }, "ImpersonationOut": { "properties": { "access_token": { "title": "Access Token", "type": "string" }, "email": { "title": "Email", "type": "string" }, "name": { "title": "Name", "type": "string" }, "token_type": { "default": "bearer", "title": "Token Type", "type": "string" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" } }, "required": [ "access_token", "user_id", "email", "name" ], "title": "ImpersonationOut", "type": "object" }, "InquiryMatchOut": { "description": "Identity previously searched on the platform but absent from the\ndataset. Stubs are a PLATFORM-WIDE people index (no org scoping) built\nfrom what any customer typed, so raw contact fields ship unmasked ONLY\nwhen the requesting org actually paid a credit for this search. Any\nuncharged path \u2014 the blinded free preview OR a zero-result refund \u2014\nmasks to name + state + presence markers, exactly like a blinded record\nsummary. Revealing raw email/phone/DOB on an uncharged search would turn\na free, cross-tenant zero-result probe into a contact-enrichment oracle.", "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Of Birth" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "first_searched_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "First Searched At" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "id": { "title": "Id", "type": "string" }, "last_searched_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Searched At" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "times_searched": { "title": "Times Searched", "type": "integer" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" } }, "required": [ "id", "full_name", "date_of_birth", "city", "state", "zip", "email", "phone", "times_searched", "first_searched_at", "last_searched_at" ], "title": "InquiryMatchOut", "type": "object" }, "InvitationOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "role": { "$ref": "#/components/schemas/Role" } }, "required": [ "id", "email", "role", "expires_at", "created_at" ], "title": "InvitationOut", "type": "object" }, "InviteCreate": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" }, "role": { "$ref": "#/components/schemas/Role", "default": "member" } }, "required": [ "email" ], "title": "InviteCreate", "type": "object" }, "InvoiceOut": { "properties": { "amount_due": { "title": "Amount Due", "type": "integer" }, "created": { "format": "date-time", "title": "Created", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "hosted_invoice_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hosted Invoice Url" }, "id": { "title": "Id", "type": "string" }, "invoice_pdf": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invoice Pdf" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Number" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "number", "status", "amount_due", "currency", "created", "hosted_invoice_url", "invoice_pdf" ], "title": "InvoiceOut", "type": "object" }, "LlmCallOut": { "properties": { "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credits_cost": { "title": "Credits Cost", "type": "integer" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "model": { "title": "Model", "type": "string" }, "prompt": { "title": "Prompt", "type": "string" }, "provider": { "$ref": "#/components/schemas/LlmProvider" }, "response_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Response Text" }, "status": { "$ref": "#/components/schemas/LlmCallStatus" }, "tokens_in": { "title": "Tokens In", "type": "integer" }, "tokens_out": { "title": "Tokens Out", "type": "integer" } }, "required": [ "id", "provider", "model", "prompt", "status", "response_text", "tokens_in", "tokens_out", "credits_cost", "error", "created_at", "completed_at" ], "title": "LlmCallOut", "type": "object" }, "LlmCallStatus": { "enum": [ "pending", "succeeded", "failed" ], "title": "LlmCallStatus", "type": "string" }, "LlmProvider": { "enum": [ "gemini", "openai", "anthropic" ], "title": "LlmProvider", "type": "string" }, "LoginRequest": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" }, "password": { "title": "Password", "type": "string" } }, "required": [ "email", "password" ], "title": "LoginRequest", "type": "object" }, "MatchedAddressOut": { "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "house_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "House Number" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "street_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street Name" }, "street_suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Street Suffix" }, "unit_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit Number" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" } }, "title": "MatchedAddressOut", "type": "object" }, "MemberLimitIn": { "properties": { "monthly_limit": { "minimum": 1.0, "title": "Monthly Limit", "type": "integer" } }, "required": [ "monthly_limit" ], "title": "MemberLimitIn", "type": "object" }, "MemberLimitOut": { "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "monthly_limit": { "title": "Monthly Limit", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "used_this_period": { "title": "Used This Period", "type": "integer" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" } }, "required": [ "user_id", "email", "monthly_limit", "used_this_period", "updated_at" ], "title": "MemberLimitOut", "type": "object" }, "MemberOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "role": { "$ref": "#/components/schemas/Role" }, "user_id": { "format": "uuid", "title": "User Id", "type": "string" } }, "required": [ "id", "user_id", "email", "name", "role", "created_at" ], "title": "MemberOut", "type": "object" }, "MergeOrgsOut": { "properties": { "members_moved": { "title": "Members Moved", "type": "integer" }, "merged_count": { "title": "Merged Count", "type": "integer" }, "target_id": { "format": "uuid", "title": "Target Id", "type": "string" } }, "required": [ "target_id", "merged_count", "members_moved" ], "title": "MergeOrgsOut", "type": "object" }, "MergeOrgsRequest": { "properties": { "source_ids": { "items": { "format": "uuid", "type": "string" }, "maxItems": 50, "minItems": 1, "title": "Source Ids", "type": "array" }, "target_id": { "format": "uuid", "title": "Target Id", "type": "string" } }, "required": [ "target_id", "source_ids" ], "title": "MergeOrgsRequest", "type": "object" }, "MetricExclusionOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "note": { "title": "Note", "type": "string" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Name" }, "value": { "title": "Value", "type": "string" } }, "required": [ "id", "kind", "value", "note", "organization_name", "created_at" ], "title": "MetricExclusionOut", "type": "object" }, "MetricExclusionsOut": { "properties": { "email_domains": { "items": { "$ref": "#/components/schemas/MetricExclusionOut" }, "title": "Email Domains", "type": "array" }, "organizations": { "items": { "$ref": "#/components/schemas/MetricExclusionOut" }, "title": "Organizations", "type": "array" } }, "required": [ "organizations", "email_domains" ], "title": "MetricExclusionsOut", "type": "object" }, "MetricPointOut": { "properties": { "currency": { "title": "Currency", "type": "string" }, "date": { "title": "Date", "type": "string" }, "value": { "title": "Value", "type": "number" } }, "required": [ "date", "value", "currency" ], "title": "MetricPointOut", "type": "object" }, "MetricSummaryOut": { "properties": { "currency": { "title": "Currency", "type": "string" }, "current": { "title": "Current", "type": "number" }, "delta_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Delta Pct" }, "metric": { "title": "Metric", "type": "string" }, "previous": { "title": "Previous", "type": "number" } }, "required": [ "metric", "currency", "current", "previous", "delta_pct" ], "title": "MetricSummaryOut", "type": "object" }, "MissReplayIn": { "properties": { "days": { "default": 30, "maximum": 90.0, "minimum": 1.0, "title": "Days", "type": "integer" } }, "title": "MissReplayIn", "type": "object" }, "OrgCreate": { "properties": { "intended_use": { "maxLength": 500, "minLength": 1, "title": "Intended Use", "type": "string" }, "name": { "maxLength": 120, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name", "intended_use" ], "title": "OrgCreate", "type": "object" }, "OrgDomainUpdate": { "description": "domain=null releases the claim.", "properties": { "domain": { "anyOf": [ { "maxLength": 253, "minLength": 4, "type": "string" }, { "type": "null" } ], "title": "Domain" } }, "title": "OrgDomainUpdate", "type": "object" }, "OrgUpdate": { "properties": { "name": { "maxLength": 120, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "OrgUpdate", "type": "object" }, "OrgWithRole": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Domain" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "role": { "$ref": "#/components/schemas/Role" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "id", "name", "slug", "created_at", "role" ], "title": "OrgWithRole", "type": "object" }, "OwnerType": { "enum": [ "person", "trust", "llc", "government", "unknown" ], "title": "OwnerType", "type": "string" }, "OwnershipLinkOut": { "properties": { "confidence": { "title": "Confidence", "type": "number" }, "match_method": { "title": "Match Method", "type": "string" }, "matched_at": { "title": "Matched At", "type": "string" }, "parcel_id": { "title": "Parcel Id", "type": "string" }, "record_id": { "title": "Record Id", "type": "string" } }, "required": [ "record_id", "parcel_id", "confidence", "match_method", "matched_at" ], "title": "OwnershipLinkOut", "type": "object" }, "Page_AdminAbuseAlertOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminAbuseAlertOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminAbuseAlertOut]", "type": "object" }, "Page_AdminAllSearchOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminAllSearchOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminAllSearchOut]", "type": "object" }, "Page_AdminApiKeyHealthOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminApiKeyHealthOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminApiKeyHealthOut]", "type": "object" }, "Page_AdminAuditOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminAuditOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminAuditOut]", "type": "object" }, "Page_AdminCustomerUsageOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminCustomerUsageOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminCustomerUsageOut]", "type": "object" }, "Page_AdminErrorEventOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminErrorEventOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminErrorEventOut]", "type": "object" }, "Page_AdminFailedSearchOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminFailedSearchOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminFailedSearchOut]", "type": "object" }, "Page_AdminGenerationOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminGenerationOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminGenerationOut]", "type": "object" }, "Page_AdminInquirySubjectOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminInquirySubjectOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminInquirySubjectOut]", "type": "object" }, "Page_AdminInvitationOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminInvitationOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminInvitationOut]", "type": "object" }, "Page_AdminOrgOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminOrgOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminOrgOut]", "type": "object" }, "Page_AdminUserOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminUserOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminUserOut]", "type": "object" }, "Page_AdminWalletOut_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AdminWalletOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "Page[AdminWalletOut]", "type": "object" }, "PrivacyRequestOut": { "properties": { "admin_notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Admin Notes" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "fulfilled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Fulfilled At" }, "fulfilled_by_user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Fulfilled By User Id" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "matched_record_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Matched Record Count" }, "payload_purged_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Payload Purged At" }, "provider_forwarded_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Provider Forwarded At" }, "provider_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Reference" }, "rejection_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rejection Reason" }, "request_payload": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Request Payload" }, "request_type": { "enum": [ "access", "delete", "suppress" ], "title": "Request Type", "type": "string" }, "requester_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requester Email" }, "requester_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requester Name" }, "status": { "enum": [ "received", "verified", "forwarded", "fulfilled", "closed", "rejected" ], "title": "Status", "type": "string" }, "subject_consumer_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Consumer Key" }, "subject_consumer_key_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Consumer Key Hash" }, "subject_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Email" }, "subject_email_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Email Hash" }, "subject_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject First Name" }, "subject_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Last Name" }, "subject_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Phone" }, "subject_phone_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject Phone Hash" }, "suppression_ids": { "items": { "type": "string" }, "title": "Suppression Ids", "type": "array" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "request_type", "status", "created_at", "updated_at" ], "title": "PrivacyRequestOut", "type": "object" }, "PrivacyRequestPage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PrivacyRequestOut" }, "title": "Items", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "page_size": { "title": "Page Size", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "items", "total", "page", "page_size" ], "title": "PrivacyRequestPage", "type": "object" }, "PrivacyRequestSubmitIn": { "properties": { "notes": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Notes" }, "request_type": { "enum": [ "access", "delete", "suppress" ], "title": "Request Type", "type": "string" }, "requester_email": { "format": "email", "title": "Requester Email", "type": "string" }, "requester_name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Requester Name" }, "subject_consumer_key": { "anyOf": [ { "maxLength": 160, "type": "string" }, { "type": "null" } ], "title": "Subject Consumer Key" }, "subject_email": { "anyOf": [ { "format": "email", "type": "string" }, { "type": "null" } ], "title": "Subject Email" }, "subject_first_name": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Subject First Name" }, "subject_last_name": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Subject Last Name" }, "subject_phone": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Subject Phone" } }, "required": [ "request_type", "requester_email" ], "title": "PrivacyRequestSubmitIn", "type": "object" }, "PrivacyRequestSubmitOut": { "properties": { "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "message": { "default": "We received your request. We may contact you to verify your identity before fulfilling it.", "title": "Message", "type": "string" }, "request_type": { "enum": [ "access", "delete", "suppress" ], "title": "Request Type", "type": "string" }, "status": { "enum": [ "received", "verified", "forwarded", "fulfilled", "closed", "rejected" ], "title": "Status", "type": "string" } }, "required": [ "id", "request_type", "status", "deadline_at" ], "title": "PrivacyRequestSubmitOut", "type": "object" }, "PromptRuleOut": { "description": "The after-N-actions popup rule, as it is actually configured right now.\n\nServed rather than hardcoded in the client because the threshold is an\nenv-tunable setting \u2014 a number typed into the admin UI would be a guess.", "properties": { "action_threshold": { "title": "Action Threshold", "type": "integer" }, "max_asks": { "title": "Max Asks", "type": "integer" }, "prompt_key": { "title": "Prompt Key", "type": "string" }, "snooze_after_ask_days": { "title": "Snooze After Ask Days", "type": "integer" }, "snooze_after_dismiss_days": { "title": "Snooze After Dismiss Days", "type": "integer" }, "state_counts": { "additionalProperties": { "type": "integer" }, "title": "State Counts", "type": "object" } }, "required": [ "prompt_key", "action_threshold", "max_asks", "snooze_after_ask_days", "snooze_after_dismiss_days", "state_counts" ], "title": "PromptRuleOut", "type": "object" }, "PromptState": { "description": "Terminal-ness matters: SUBMITTED is forever, DISMISSED is a long snooze.", "enum": [ "asked", "dismissed", "submitted" ], "title": "PromptState", "type": "string" }, "PropertyOut": { "properties": { "acreage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Acreage" }, "assessed_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Assessed Value" }, "fips_code": { "title": "Fips Code", "type": "string" }, "land_use": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Land Use" }, "mailing_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailing Address" }, "mailing_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailing City" }, "mailing_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailing State" }, "mailing_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mailing Zip" }, "owner_name_raw": { "title": "Owner Name Raw", "type": "string" }, "owner_type": { "$ref": "#/components/schemas/OwnerType" }, "parcel_id": { "title": "Parcel Id", "type": "string" }, "refresh_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh Date" }, "situs_address": { "title": "Situs Address", "type": "string" }, "situs_city": { "title": "Situs City", "type": "string" }, "situs_state": { "title": "Situs State", "type": "string" }, "situs_zip": { "title": "Situs Zip", "type": "string" }, "source": { "title": "Source", "type": "string" } }, "required": [ "parcel_id", "fips_code", "owner_name_raw", "owner_type", "situs_address", "situs_city", "situs_state", "situs_zip", "source" ], "title": "PropertyOut", "type": "object" }, "PropertyPageOut": { "properties": { "has_more": { "title": "Has More", "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/PropertyOut" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "links": { "items": { "$ref": "#/components/schemas/OwnershipLinkOut" }, "title": "Links", "type": "array" }, "offset": { "title": "Offset", "type": "integer" } }, "required": [ "items", "links", "has_more", "limit", "offset" ], "title": "PropertyPageOut", "type": "object" }, "PublicCheckStatsOut": { "properties": { "newest_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Newest At" }, "oldest_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Oldest At" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "total", "oldest_at", "newest_at" ], "title": "PublicCheckStatsOut", "type": "object" }, "PurgePublicChecksIn": { "properties": { "before": { "format": "date-time", "title": "Before", "type": "string" } }, "required": [ "before" ], "title": "PurgePublicChecksIn", "type": "object" }, "PurgePublicChecksOut": { "properties": { "deleted": { "title": "Deleted", "type": "integer" } }, "required": [ "deleted" ], "title": "PurgePublicChecksOut", "type": "object" }, "QuerySurface": { "description": "Channel a query arrived through \u2014 recorded, never re-derived.", "enum": [ "web", "api", "public", "admin" ], "title": "QuerySurface", "type": "string" }, "QueryWindowMetricsOut": { "properties": { "by_action": { "items": { "$ref": "#/components/schemas/CategoryCountOut" }, "title": "By Action", "type": "array" }, "by_surface": { "items": { "$ref": "#/components/schemas/CategoryCountOut" }, "title": "By Surface", "type": "array" }, "p50_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "P50 Ms" }, "p95_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "P95 Ms" }, "p99_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "P99 Ms" }, "total": { "title": "Total", "type": "integer" }, "window_hours": { "title": "Window Hours", "type": "integer" }, "zero_result": { "title": "Zero Result", "type": "integer" }, "zero_result_rate_pct": { "title": "Zero Result Rate Pct", "type": "number" } }, "required": [ "window_hours", "total", "zero_result", "zero_result_rate_pct", "p50_ms", "p95_ms", "p99_ms", "by_action", "by_surface" ], "title": "QueryWindowMetricsOut", "type": "object" }, "RecentBonusOut": { "properties": { "amount": { "title": "Amount", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "format": "uuid", "title": "Id", "type": "string" } }, "required": [ "id", "amount", "description", "created_at" ], "title": "RecentBonusOut", "type": "object" }, "RecentQueriesOut": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RecentQueryOut" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "RecentQueriesOut", "type": "object" }, "RecentQueryOut": { "properties": { "action": { "title": "Action", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "query_params": { "additionalProperties": true, "title": "Query Params", "type": "object" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "result_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Result Count" } }, "required": [ "id", "action", "query_params", "record_id", "result_count", "created_at" ], "title": "RecentQueryOut", "type": "object" }, "RecordAccessInfoOut": { "properties": { "credit_cost": { "title": "Credit Cost", "type": "integer" }, "previously_accessed": { "title": "Previously Accessed", "type": "boolean" } }, "required": [ "previously_accessed", "credit_cost" ], "title": "RecordAccessInfoOut", "type": "object" }, "RecordDetailOut": { "description": "Record for the detail view. Full (unmasked) when the view was\ncredit-charged; the masked variant (`from_entity_preview`) serves both\nthe free /preview endpoint and the auto-degraded zero-credit view.", "properties": { "_meta": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Meta" }, "addresses": { "items": { "additionalProperties": true, "type": "object" }, "title": "Addresses", "type": "array" }, "age": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Age" }, "alternate_names": { "items": { "additionalProperties": true, "type": "object" }, "title": "Alternate Names", "type": "array" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created At" }, "credits_charged": { "default": 0, "title": "Credits Charged", "type": "integer" }, "date_of_birth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Of Birth" }, "deceased": { "title": "Deceased", "type": "boolean" }, "device_ids": { "items": { "type": "string" }, "title": "Device Ids", "type": "array" }, "emails": { "items": { "additionalProperties": true, "type": "object" }, "title": "Emails", "type": "array" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "full_name": { "title": "Full Name", "type": "string" }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender" }, "id": { "title": "Id", "type": "string" }, "ip_addresses": { "items": { "type": "string" }, "title": "Ip Addresses", "type": "array" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "masked": { "default": false, "title": "Masked", "type": "boolean" }, "middle_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Middle Name" }, "phones": { "items": { "additionalProperties": true, "type": "object" }, "title": "Phones", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prefix" }, "preview": { "default": false, "title": "Preview", "type": "boolean" }, "primary_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary City" }, "primary_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary State" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suffix" }, "unmask": { "anyOf": [ { "$ref": "#/components/schemas/UnmaskHintOut" }, { "type": "null" } ] } }, "required": [ "id", "full_name", "prefix", "first_name", "middle_name", "last_name", "suffix", "gender", "date_of_birth", "age", "deceased", "alternate_names", "addresses", "phones", "emails", "ip_addresses", "device_ids", "created_at" ], "title": "RecordDetailOut", "type": "object" }, "RecordPageOut": { "properties": { "blinded": { "default": false, "description": "True when this page is the zero-credit free preview (heavier masking).", "title": "Blinded", "type": "boolean" }, "deduped": { "default": false, "description": "True when this was a free re-run of a search the actor already paid for.", "title": "Deduped", "type": "boolean" }, "has_more": { "title": "Has More", "type": "boolean" }, "inquiry_masked": { "default": false, "description": "Inquiry stubs are masked whenever the search was uncharged (`blinded` OR `refunded`), independent of row masking \u2014 clients must check this flag, not the phrase.", "title": "Inquiry Masked", "type": "boolean" }, "inquiry_matches": { "description": "Inquiry-derived stubs matching the criteria (first page only). Inquiry-derived stubs are NOT dataset records \u2014 their ids cannot be used with next_step.url_template.", "items": { "$ref": "#/components/schemas/InquiryMatchOut" }, "title": "Inquiry Matches", "type": "array" }, "items": { "items": { "$ref": "#/components/schemas/RecordSummaryOut" }, "title": "Items", "type": "array" }, "limit": { "title": "Limit", "type": "integer" }, "masked": { "default": false, "description": "Mirrors `blinded` (kept for back-compat); pairs with `unmask` as the machine-readable signal that field values carry MASK_PHRASE / nulls.", "title": "Masked", "type": "boolean" }, "masking": { "anyOf": [ { "$ref": "#/components/schemas/SearchMaskingOut" }, { "type": "null" } ], "description": "Why list contact fields look masked (`teaser` vs `blinded`) and the remedy. Always populated on search responses. Branch on state/remedy, never on message text." }, "match_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Deepest ladder tier among the returned rows (see domain/tiers.py): None when every row satisfied everything typed. Per-row tiers live on each item's match_tier.", "title": "Match Type" }, "next_step": { "anyOf": [ { "$ref": "#/components/schemas/SearchNextStepOut" }, { "type": "null" } ], "description": "How to fetch a listed record: method, URL templates, credit_cost, free re-fetch window, and the 428 shared-access header. Always populated on search responses." }, "offset": { "title": "Offset", "type": "integer" }, "refunded": { "default": false, "description": "True when the search found nothing at any ladder tier and the credit hold was released \u2014 the caller was not charged.", "title": "Refunded", "type": "boolean" }, "relaxed": { "description": "Typed criteria the page-level tier did not enforce as filters.", "items": { "type": "string" }, "title": "Relaxed", "type": "array" }, "tiers": { "description": "Distinct row tiers present, shallowest-first \u2014 lets the UI show a mixed-page banner when the cascade combined tiers.", "items": { "type": "string" }, "title": "Tiers", "type": "array" }, "unmask": { "anyOf": [ { "$ref": "#/components/schemas/UnmaskHintOut" }, { "type": "null" } ], "description": "Machine-readable hint accompanying MASK_PHRASE field values. Non-null iff `masked` is True." }, "zero_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why an empty first page came back empty, when the backend can tell: \"contact_unknown\" (typed email/phone not on file and the other criteria were too thin to search alone) or \"deceased_filter\" (matches exist but the deceased filter excluded all of them). None for a plain coverage gap and always None on blinded free-tier responses.", "title": "Zero Reason" } }, "required": [ "items", "has_more", "limit", "offset" ], "title": "RecordPageOut", "type": "object" }, "RecordQueryAction": { "enum": [ "search", "view", "preview", "address_lookup", "identity_check" ], "title": "RecordQueryAction", "type": "string" }, "RecordSummaryOut": { "description": "Compact shape for the list/search view \u2014 contact fields are masked.\n\n``blinded=True`` (the zero-credit free preview) is echo-only: rows show\nthe GD- id, first name, state, and deceased flag, plus a field only when\nthe caller searched by it (``echo``). Everything else carries MASK_PHRASE\n(string fields with a value) or null, so the free tier mirrors what the\ncaller typed without leaking anything new to scrape.", "properties": { "age": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Age" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "deceased": { "title": "Deceased", "type": "boolean" }, "detail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Absolute URL for this row's record profile (GET). Present on items[] only \u2014 not on inquiry_matches[]. A syntactic transform of org path + id.", "title": "Detail Url" }, "email_masked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email at teaser fidelity (e.g. j***@example.com) when present. Always teaser fidelity on lists, even when the search was charged \u2014 the record's contact fields come from detail_url.", "title": "Email Masked" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Name" }, "full_name": { "title": "Full Name", "type": "string" }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender" }, "id": { "title": "Id", "type": "string" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "match_confidence": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "0-100 confidence against everything typed. None for an exact match or the unscored dev backend. Additive \u2014 pre-cascade clients ignore it.", "title": "Match Confidence" }, "match_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "How this row matched (ladder tier, domain/tiers.py). None for an exact match or the unscored dev backend. Additive \u2014 pre-cascade clients ignore it.", "title": "Match Tier" }, "phone_masked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Phone at teaser fidelity when present. Always teaser fidelity on lists, even when the search was charged \u2014 the record's contact fields come from detail_url.", "title": "Phone Masked" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" }, "zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zip" } }, "required": [ "id", "full_name", "first_name", "last_name", "gender", "age", "deceased", "city", "state", "zip", "email_masked", "phone_masked" ], "title": "RecordSummaryOut", "type": "object" }, "RedirectResponse": { "properties": { "url": { "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "RedirectResponse", "type": "object" }, "ReferralEmailRequest": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" } }, "required": [ "email" ], "title": "ReferralEmailRequest", "type": "object" }, "ReferralEmailSent": { "properties": { "status": { "default": "sent", "title": "Status", "type": "string" } }, "title": "ReferralEmailSent", "type": "object" }, "ReferralSettingsOut": { "properties": { "invite_bonus_cap": { "title": "Invite Bonus Cap", "type": "integer" }, "invite_bonus_credits": { "title": "Invite Bonus Credits", "type": "integer" }, "org_referral_cap": { "title": "Org Referral Cap", "type": "integer" }, "org_referral_credits": { "title": "Org Referral Credits", "type": "integer" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "invite_bonus_credits", "invite_bonus_cap", "org_referral_credits", "org_referral_cap", "updated_at" ], "title": "ReferralSettingsOut", "type": "object" }, "ReferralSettingsUpdateRequest": { "description": "0 credits disables that program; caps bound total exposure per org.", "properties": { "invite_bonus_cap": { "maximum": 10000.0, "minimum": 0.0, "title": "Invite Bonus Cap", "type": "integer" }, "invite_bonus_credits": { "maximum": 100000.0, "minimum": 0.0, "title": "Invite Bonus Credits", "type": "integer" }, "org_referral_cap": { "maximum": 10000.0, "minimum": 0.0, "title": "Org Referral Cap", "type": "integer" }, "org_referral_credits": { "maximum": 100000.0, "minimum": 0.0, "title": "Org Referral Credits", "type": "integer" } }, "required": [ "invite_bonus_credits", "invite_bonus_cap", "org_referral_credits", "org_referral_cap" ], "title": "ReferralSettingsUpdateRequest", "type": "object" }, "ReferralSummaryOut": { "properties": { "code": { "title": "Code", "type": "string" }, "invite_bonus_cap": { "title": "Invite Bonus Cap", "type": "integer" }, "invite_bonus_credits": { "title": "Invite Bonus Credits", "type": "integer" }, "invite_bonuses_earned": { "title": "Invite Bonuses Earned", "type": "integer" }, "org_referral_cap": { "title": "Org Referral Cap", "type": "integer" }, "org_referral_credits": { "title": "Org Referral Credits", "type": "integer" }, "org_referrals_paid": { "title": "Org Referrals Paid", "type": "integer" }, "org_referrals_pending": { "title": "Org Referrals Pending", "type": "integer" }, "recent_bonuses": { "items": { "$ref": "#/components/schemas/RecentBonusOut" }, "title": "Recent Bonuses", "type": "array" } }, "required": [ "code", "invite_bonus_credits", "invite_bonus_cap", "invite_bonuses_earned", "org_referral_credits", "org_referral_cap", "org_referrals_paid", "org_referrals_pending", "recent_bonuses" ], "title": "ReferralSummaryOut", "type": "object" }, "RegisterRequest": { "properties": { "email": { "format": "email", "title": "Email", "type": "string" }, "first_name": { "maxLength": 60, "minLength": 1, "title": "First Name", "type": "string" }, "last_name": { "default": "", "maxLength": 60, "title": "Last Name", "type": "string" }, "marketing_opt_in": { "default": false, "title": "Marketing Opt In", "type": "boolean" }, "password": { "maxLength": 128, "title": "Password", "type": "string" }, "password_confirmation": { "maxLength": 128, "title": "Password Confirmation", "type": "string" }, "permitted_use_accepted": { "title": "Permitted Use Accepted", "type": "boolean" }, "referral_code": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Referral Code" }, "terms_accepted": { "title": "Terms Accepted", "type": "boolean" } }, "required": [ "first_name", "email", "password", "password_confirmation", "terms_accepted", "permitted_use_accepted" ], "title": "RegisterRequest", "type": "object" }, "RejectIn": { "properties": { "reason": { "maxLength": 1000, "minLength": 1, "title": "Reason", "type": "string" } }, "required": [ "reason" ], "title": "RejectIn", "type": "object" }, "RerunResultOut": { "properties": { "match_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Type" }, "new_result_count": { "title": "New Result Count", "type": "integer" }, "notified": { "default": false, "title": "Notified", "type": "boolean" }, "organization_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Organization Name" }, "query_params": { "additionalProperties": true, "title": "Query Params", "type": "object" }, "search_id": { "format": "uuid", "title": "Search Id", "type": "string" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" } }, "required": [ "search_id", "user_email", "organization_name", "query_params", "new_result_count", "match_type" ], "title": "RerunResultOut", "type": "object" }, "RerunSummaryOut": { "properties": { "notified": { "title": "Notified", "type": "integer" }, "now_have_results": { "title": "Now Have Results", "type": "integer" }, "results": { "items": { "$ref": "#/components/schemas/RerunResultOut" }, "title": "Results", "type": "array" }, "total_rerun": { "title": "Total Rerun", "type": "integer" } }, "required": [ "total_rerun", "now_have_results", "notified", "results" ], "title": "RerunSummaryOut", "type": "object" }, "ReservationOut": { "properties": { "action": { "$ref": "#/components/schemas/CreditAction" }, "amount": { "title": "Amount", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference" }, "status": { "$ref": "#/components/schemas/ReservationStatus" } }, "required": [ "id", "action", "amount", "status", "reference", "expires_at", "created_at" ], "title": "ReservationOut", "type": "object" }, "ReservationStatus": { "enum": [ "pending", "captured", "released", "expired" ], "title": "ReservationStatus", "type": "string" }, "ResetPasswordRequest": { "properties": { "password": { "maxLength": 128, "title": "Password", "type": "string" }, "password_confirmation": { "maxLength": 128, "title": "Password Confirmation", "type": "string" }, "token": { "title": "Token", "type": "string" } }, "required": [ "token", "password", "password_confirmation" ], "title": "ResetPasswordRequest", "type": "object" }, "Role": { "enum": [ "owner", "admin", "member" ], "title": "Role", "type": "string" }, "RoleUpdate": { "properties": { "role": { "$ref": "#/components/schemas/Role" } }, "required": [ "role" ], "title": "RoleUpdate", "type": "object" }, "RunOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Finished At" }, "floor": { "title": "Floor", "type": "integer" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "progress_done": { "title": "Progress Done", "type": "integer" }, "progress_total": { "title": "Progress Total", "type": "integer" }, "sample_size": { "title": "Sample Size", "type": "integer" }, "scorecard": { "additionalProperties": true, "title": "Scorecard", "type": "object" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Started At" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "status", "sample_size", "floor", "progress_done", "progress_total", "scorecard", "error", "created_at", "started_at", "finished_at" ], "title": "RunOut", "type": "object" }, "SearchClickOut": { "description": "One record clicked into after a search (a VIEW event).", "properties": { "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "query_id": { "format": "uuid", "title": "Query Id", "type": "string" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "surface": { "title": "Surface", "type": "string" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "viewed_at": { "format": "date-time", "title": "Viewed At", "type": "string" } }, "required": [ "query_id", "record_id", "full_name", "viewed_at", "surface", "user_email" ], "title": "SearchClickOut", "type": "object" }, "SearchMaskingOut": { "description": "Why list contact fields look masked, and the remedy. Distinguishes\nteaser (always on lists) from blinded (zero-credit echo-only rows).", "properties": { "message": { "description": "Human-readable guidance. Clients must branch on state / remedy, never parse this text.", "title": "Message", "type": "string" }, "remedy": { "description": "How to obtain non-teaser data: \"fetch_record\" (use detail_url / next_step) or \"buy_credits\" (fund the org and re-run the search).", "title": "Remedy", "type": "string" }, "state": { "description": "Masking layer on this page: \"teaser\" (charged list) or \"blinded\" (free preview).", "title": "State", "type": "string" }, "teaser_fields": { "description": "List fields that always ship at teaser fidelity, even on charged searches.", "items": { "type": "string" }, "title": "Teaser Fields", "type": "array" } }, "required": [ "state", "remedy", "message" ], "title": "SearchMaskingOut", "type": "object" }, "SearchNextStepOut": { "description": "How to fetch a listed record's profile \u2014 cost, free re-fetch window,\nand the 428 shared-access confirmation header. Pure guidance from\nsettings + static credit costs; never per-record state.", "properties": { "access_info_url_template": { "description": "Absolute URL template for access-info (credit cost and whether this org already accessed the record).", "title": "Access Info Url Template", "type": "string" }, "action": { "default": "fetch_record", "description": "Machine-readable next action for items[] rows: always fetch_record.", "title": "Action", "type": "string" }, "confirm_shared_access_header": { "default": "X-Confirm-Shared-Access", "description": "Header name to resend on HTTP 428: the record was first unlocked by another organization. Set to any value to confirm and retry.", "title": "Confirm Shared Access Header", "type": "string" }, "credit_cost": { "description": "Credits charged for a first-time record retrieval (fixed ACTION cost).", "title": "Credit Cost", "type": "integer" }, "free_refetch_minutes": { "default": 10, "description": "Re-fetching the same record within this many minutes is not re-charged (matches RECORD_VIEW_DEDUP).", "title": "Free Refetch Minutes", "type": "integer" }, "message": { "default": "To retrieve a record, GET its detail_url \u2014 or substitute an items[].id into url_template. Each retrieval charges credit_cost credits and returns the contact fields the record holds; re-fetching the same record within free_refetch_minutes minutes is not re-charged. A 428 response means the record was first unlocked by another organization: retry with the X-Confirm-Shared-Access header set to any value. Applies to items[] only \u2014 inquiry_matches[] are search-activity stubs with no detail endpoint.", "description": "Human-readable guidance. Clients must branch on structured fields (action, credit_cost, confirm_shared_access_header), never parse this text.", "title": "Message", "type": "string" }, "method": { "default": "GET", "description": "HTTP method for url_template / detail_url.", "title": "Method", "type": "string" }, "preview_url_template": { "description": "Absolute URL template for the free masked preview of a record.", "title": "Preview Url Template", "type": "string" }, "url_template": { "description": "Absolute URL template for a record profile; substitute an items[].id for {record_id}. Prefer the per-row detail_url when present.", "title": "Url Template", "type": "string" } }, "required": [ "url_template", "credit_cost", "preview_url_template", "access_info_url_template" ], "title": "SearchNextStepOut", "type": "object" }, "SearchOutcomeOut": { "description": "Per-search click-through detail + friction flags.", "properties": { "clicks": { "items": { "$ref": "#/components/schemas/SearchClickOut" }, "title": "Clicks", "type": "array" }, "distinct_profile_count": { "title": "Distinct Profile Count", "type": "integer" }, "followed_by_research": { "title": "Followed By Research", "type": "boolean" }, "outcome": { "title": "Outcome", "type": "string" } }, "required": [ "clicks", "distinct_profile_count", "followed_by_research", "outcome" ], "title": "SearchOutcomeOut", "type": "object" }, "SessionResponse": { "properties": { "access_token": { "title": "Access Token", "type": "string" }, "token_type": { "default": "bearer", "title": "Token Type", "type": "string" }, "user": { "$ref": "#/components/schemas/UserOut" } }, "required": [ "access_token", "user" ], "title": "SessionResponse", "type": "object" }, "SourceColumnOut": { "description": "One named column in an upstream raw delivery.", "properties": { "block": { "title": "Block", "type": "string" }, "data_type": { "title": "Data Type", "type": "string" }, "description": { "title": "Description", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "name", "description", "data_type", "block" ], "title": "SourceColumnOut", "type": "object" }, "SubjectMatchOut": { "properties": { "consumer_key": { "title": "Consumer Key", "type": "string" }, "email_masked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email Masked" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name" }, "phone_masked": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Masked" }, "primary_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary City" }, "primary_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary State" }, "primary_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Zip" } }, "required": [ "consumer_key" ], "title": "SubjectMatchOut", "type": "object" }, "TimeseriesPointOut": { "properties": { "count": { "title": "Count", "type": "integer" }, "date": { "title": "Date", "type": "string" } }, "required": [ "date", "count" ], "title": "TimeseriesPointOut", "type": "object" }, "TokenResponse": { "properties": { "access_token": { "title": "Access Token", "type": "string" }, "token_type": { "default": "bearer", "title": "Token Type", "type": "string" } }, "required": [ "access_token" ], "title": "TokenResponse", "type": "object" }, "TopCustomerOut": { "properties": { "name": { "title": "Name", "type": "string" }, "value": { "title": "Value", "type": "integer" } }, "required": [ "name", "value" ], "title": "TopCustomerOut", "type": "object" }, "TourSeenIn": { "properties": { "status": { "enum": [ "completed", "skipped" ], "title": "Status", "type": "string" } }, "required": [ "status" ], "title": "TourSeenIn", "type": "object" }, "TransactionOut": { "properties": { "action": { "anyOf": [ { "$ref": "#/components/schemas/CreditAction" }, { "type": "null" } ] }, "amount": { "title": "Amount", "type": "integer" }, "api_key_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Name" }, "balance_after": { "title": "Balance After", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "reservation_status": { "anyOf": [ { "$ref": "#/components/schemas/ReservationStatus" }, { "type": "null" } ] }, "type": { "$ref": "#/components/schemas/TransactionType" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" } }, "required": [ "id", "type", "action", "amount", "balance_after", "description", "user_email", "reservation_status", "created_at" ], "title": "TransactionOut", "type": "object" }, "TransactionType": { "enum": [ "grant", "hold", "release", "expire", "adjustment" ], "title": "TransactionType", "type": "string" }, "UnmaskHintOut": { "description": "Machine-readable companion to MASK_PHRASE: how to unmask this\nresponse. Present iff the top-level `masked` flag is True.", "properties": { "credit_cost": { "title": "Credit Cost", "type": "integer" }, "message": { "default": "Buy credits to unmask.", "title": "Message", "type": "string" }, "purchase_url": { "default": "/billing", "title": "Purchase Url", "type": "string" } }, "required": [ "credit_cost" ], "title": "UnmaskHintOut", "type": "object" }, "UpdateMeRequest": { "description": "Partial update \u2014 only the provided fields change.", "properties": { "first_name": { "anyOf": [ { "maxLength": 60, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "First Name" }, "last_name": { "anyOf": [ { "maxLength": 60, "type": "string" }, { "type": "null" } ], "title": "Last Name" }, "marketing_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Marketing Opt In" } }, "title": "UpdateMeRequest", "type": "object" }, "UsageActionOut": { "properties": { "action": { "$ref": "#/components/schemas/CreditAction" }, "count": { "title": "Count", "type": "integer" }, "credits": { "title": "Credits", "type": "integer" } }, "required": [ "action", "count", "credits" ], "title": "UsageActionOut", "type": "object" }, "UsageActorOut": { "properties": { "actions": { "items": { "$ref": "#/components/schemas/UsageActionOut" }, "title": "Actions", "type": "array" }, "api_key_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Api Key Id" }, "api_key_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key Name" }, "count": { "title": "Count", "type": "integer" }, "credits": { "title": "Credits", "type": "integer" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "user_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Email" }, "user_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name" } }, "required": [ "user_id", "user_email", "user_name", "api_key_id", "api_key_name", "credits", "count", "limit", "actions" ], "title": "UsageActorOut", "type": "object" }, "UsageOut": { "properties": { "items": { "items": { "$ref": "#/components/schemas/UsageActorOut" }, "title": "Items", "type": "array" }, "period": { "title": "Period", "type": "string" }, "total_actors": { "title": "Total Actors", "type": "integer" }, "total_credits": { "title": "Total Credits", "type": "integer" } }, "required": [ "period", "items", "total_actors", "total_credits" ], "title": "UsageOut", "type": "object" }, "UserOut": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "title": "Email", "type": "string" }, "email_verified": { "title": "Email Verified", "type": "boolean" }, "first_name": { "title": "First Name", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "is_superuser": { "title": "Is Superuser", "type": "boolean" }, "last_name": { "title": "Last Name", "type": "string" }, "marketing_opt_in": { "title": "Marketing Opt In", "type": "boolean" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "email", "first_name", "last_name", "name", "is_superuser", "marketing_opt_in", "email_verified", "created_at" ], "title": "UserOut", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "VerifyEmailRequest": { "properties": { "token": { "title": "Token", "type": "string" } }, "required": [ "token" ], "title": "VerifyEmailRequest", "type": "object" }, "WalletOut": { "properties": { "allowance_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Allowance Period" }, "balance": { "title": "Balance", "type": "integer" }, "monthly_allowance": { "title": "Monthly Allowance", "type": "integer" }, "pending_holds": { "items": { "$ref": "#/components/schemas/ReservationOut" }, "title": "Pending Holds", "type": "array" }, "reserved": { "title": "Reserved", "type": "integer" } }, "required": [ "balance", "reserved", "monthly_allowance", "allowance_period", "pending_holds" ], "title": "WalletOut", "type": "object" } }, "securitySchemes": { "HTTPBearer": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "Best-effort schema reference \u2014 /docs/api.md is normative. Masked (zero-credit) responses reuse the same models with `masked: true` + an `unmask` hint; errors are RFC 9457 problem+json.", "title": "CoverFi", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/api/admin/abuse-alerts": { "get": { "operationId": "list_abuse_alerts_api_admin_abuse_alerts_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "default": "open", "title": "Status" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminAbuseAlertOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Abuse Alerts", "tags": [ "admin" ] } }, "/api/admin/abuse-alerts/{alert_id}/acknowledge": { "post": { "operationId": "acknowledge_abuse_alert_api_admin_abuse_alerts__alert_id__acknowledge_post", "parameters": [ { "in": "path", "name": "alert_id", "required": true, "schema": { "format": "uuid", "title": "Alert Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbuseReviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminAbuseAlertOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Acknowledge Abuse Alert", "tags": [ "admin" ] } }, "/api/admin/analytics": { "get": { "description": "Aggregated platform analytics for the admin overview dashboard.", "operationId": "get_analytics_api_admin_analytics_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminAnalyticsOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Analytics", "tags": [ "admin" ] } }, "/api/admin/api-key-health": { "get": { "description": "Per-API-key query volume and zero-result rate.", "operationId": "list_api_key_health_api_admin_api_key_health_get", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminApiKeyHealthOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Api Key Health", "tags": [ "admin", "admin" ] } }, "/api/admin/audit-log": { "get": { "operationId": "list_audit_log_api_admin_audit_log_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminAuditOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Audit Log", "tags": [ "admin" ] } }, "/api/admin/credits": { "get": { "operationId": "list_credit_wallets_api_admin_credits_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminWalletOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Credit Wallets", "tags": [ "admin" ] } }, "/api/admin/customers": { "get": { "description": "Founder view: who signed up and how many records they pulled.\n\n`credits_spent` sums captured record-action holds.", "operationId": "list_customers_api_admin_customers_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "joined", "pattern": "^(joined|pulls)$", "title": "Sort", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminCustomerUsageOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Customers", "tags": [ "admin", "admin" ] } }, "/api/admin/customers/export.csv": { "get": { "operationId": "export_customers_csv_api_admin_customers_export_csv_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "joined", "pattern": "^(joined|pulls)$", "title": "Sort", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Export Customers Csv", "tags": [ "admin", "admin" ] } }, "/api/admin/customers/{org_id}/profile": { "get": { "description": "Full usage profile for a single customer organization.", "operationId": "get_customer_profile_api_admin_customers__org_id__profile_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCustomerUsageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Customer Profile", "tags": [ "admin", "admin" ] } }, "/api/admin/customers/{org_id}/searches": { "get": { "description": "Query events (search/view/address lookup/identity check) for one\ncustomer organization, with actor, IP, user agent, and surface.", "operationId": "list_customer_searches_api_admin_customers__org_id__searches_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordQueryAction" }, { "type": "null" } ], "title": "Action" } }, { "in": "query", "name": "surface", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuerySurface" }, { "type": "null" } ], "title": "Surface" } }, { "in": "query", "name": "result_count", "required": false, "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Result Count" } }, { "in": "query", "name": "has_results", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Results" } }, { "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "newest", "pattern": "^(newest|oldest|results_desc|results_asc)$", "title": "Sort", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCustomerSearchHistoryOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Customer Searches", "tags": [ "admin", "admin" ] } }, "/api/admin/customers/{org_id}/searches/export.csv": { "get": { "description": "CSV of filtered query history for one customer org (capped at EXPORT_CAP).", "operationId": "export_customer_searches_csv_api_admin_customers__org_id__searches_export_csv_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordQueryAction" }, { "type": "null" } ], "title": "Action" } }, { "in": "query", "name": "surface", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuerySurface" }, { "type": "null" } ], "title": "Surface" } }, { "in": "query", "name": "result_count", "required": false, "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Result Count" } }, { "in": "query", "name": "has_results", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Results" } }, { "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "newest", "pattern": "^(newest|oldest|results_desc|results_asc)$", "title": "Sort", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Export Customer Searches Csv", "tags": [ "admin", "admin" ] } }, "/api/admin/customers/{org_id}/searches/{search_id}/results": { "get": { "description": "Re-play a customer's search and return admin-visible results.\n\nNo credit charge \u2014 admin inspection only. Only ``search`` action queries\nare eligible; ``view``, ``address_lookup``, and ``identity_check`` have\ndifferent semantics and are not replayed here.", "operationId": "get_customer_search_results_api_admin_customers__org_id__searches__search_id__results_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "path", "name": "search_id", "required": true, "schema": { "format": "uuid", "title": "Search Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSearchResultsOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Customer Search Results", "tags": [ "admin", "admin" ] } }, "/api/admin/dataset-health": { "get": { "description": "Serving-layer status: dataset metadata (filesystem + optional manifest,\nNEVER a DuckDB/Parquet read \u2014 the serving box takes no dashboard load)\nplus Postgres-side query metrics from record_queries.", "operationId": "get_dataset_health_api_admin_dataset_health_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetHealthOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Dataset Health", "tags": [ "admin", "admin" ] } }, "/api/admin/dataset-sources/{source_key}": { "get": { "description": "Raw-delivery metadata from checked-in catalogs only.", "operationId": "get_dataset_source_api_admin_dataset_sources__source_key__get", "parameters": [ { "in": "path", "name": "source_key", "required": true, "schema": { "title": "Source Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetSourceDetailOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Dataset Source", "tags": [ "admin", "admin" ] } }, "/api/admin/error-events": { "get": { "description": "Persistent error events across the platform, newest first.\n\nFilter by code (e.g. ERR_REC_006 for backend saturation, ERR_CRD_001 for\ncredit walls), severity, org, or time window (default: last 24h, max 7d).", "operationId": "list_error_events_api_admin_error_events_get", "parameters": [ { "in": "query", "name": "code", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Code" } }, { "in": "query", "name": "severity", "required": false, "schema": { "anyOf": [ { "pattern": "^(info|warning|error|critical)$", "type": "string" }, { "type": "null" } ], "title": "Severity" } }, { "in": "query", "name": "organization_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" } }, { "in": "query", "name": "hours", "required": false, "schema": { "default": 24, "maximum": 168, "minimum": 1, "title": "Hours", "type": "integer" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminErrorEventOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Error Events", "tags": [ "admin", "admin" ] } }, "/api/admin/error-events/export.csv": { "get": { "operationId": "export_error_events_csv_api_admin_error_events_export_csv_get", "parameters": [ { "in": "query", "name": "code", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Code" } }, { "in": "query", "name": "severity", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Severity" } }, { "in": "query", "name": "hours", "required": false, "schema": { "default": 24, "maximum": 720, "minimum": 1, "title": "Hours", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Export Error Events Csv", "tags": [ "admin", "admin" ] } }, "/api/admin/error-events/summary": { "get": { "description": "Error counts by code and severity for the feed dashboard.", "operationId": "get_error_event_summary_api_admin_error_events_summary_get", "parameters": [ { "in": "query", "name": "hours", "required": false, "schema": { "default": 24, "maximum": 168, "minimum": 1, "title": "Hours", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEventSummaryOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Error Event Summary", "tags": [ "admin", "admin" ] } }, "/api/admin/errors/{error_id}": { "get": { "description": "Resolve a user-reported error reference to its full request context.\n\nUsers report `code \u00b7 ref` from any error surface (\"Copy details\"); this\nreturns the structured record captured at the moment of failure \u2014 route,\nstatus, client, and (for 500s) the traceback. Records live in Redis for\n7 days (see app.core.error_handling).", "operationId": "error_lookup_api_admin_errors__error_id__get", "parameters": [ { "in": "path", "name": "error_id", "required": true, "schema": { "title": "Error Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Error Lookup Api Admin Errors Error Id Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Error Lookup", "tags": [ "admin" ] } }, "/api/admin/failed-searches": { "get": { "description": "Cross-org zero-result searches, newest first.\n\nShows which search criteria return nothing across the platform so admins\ncan investigate data gaps or UX issues.", "operationId": "list_failed_searches_api_admin_failed_searches_get", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminFailedSearchOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Failed Searches", "tags": [ "admin", "admin" ] } }, "/api/admin/failed-searches/export.csv": { "get": { "operationId": "export_failed_searches_csv_api_admin_failed_searches_export_csv_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Export Failed Searches Csv", "tags": [ "admin", "admin" ] } }, "/api/admin/failed-searches/rerun": { "post": { "description": "Re-run recent failed searches through the (possibly improved) search\nlogic. When ``notify=true``, email users whose searches now return results.", "operationId": "rerun_failed_searches_api_admin_failed_searches_rerun_post", "parameters": [ { "in": "query", "name": "notify", "required": false, "schema": { "default": false, "title": "Notify", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunSummaryOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Rerun Failed Searches", "tags": [ "admin", "admin" ] } }, "/api/admin/failed-searches/{search_id}/rerun": { "post": { "description": "Re-run a single failed search and optionally notify the user.", "operationId": "rerun_single_search_api_admin_failed_searches__search_id__rerun_post", "parameters": [ { "in": "path", "name": "search_id", "required": true, "schema": { "format": "uuid", "title": "Search Id", "type": "string" } }, { "in": "query", "name": "notify", "required": false, "schema": { "default": false, "title": "Notify", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerunResultOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Rerun Single Search", "tags": [ "admin", "admin" ] } }, "/api/admin/feedback": { "get": { "operationId": "list_feedback_api_admin_feedback_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeedbackKind" }, { "type": "null" } ], "title": "Kind" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeedbackStatus" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeedbackSource" }, { "type": "null" } ], "title": "Source" } }, { "in": "query", "name": "rating", "required": false, "schema": { "anyOf": [ { "maximum": 5, "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Rating" } }, { "in": "query", "name": "has_screenshot", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Screenshot" } }, { "in": "query", "name": "organization_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "newest", "pattern": "^(newest|oldest|rating_desc|rating_asc)$", "title": "Sort", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFeedbackPageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Feedback", "tags": [ "admin" ] } }, "/api/admin/feedback/automation": { "get": { "description": "What fires automatically, with the values that are live right now.\n\nDeclared above `/feedback/{feedback_id}` so the literal path wins. Read-only\nfor now: this is the surface the thresholds will eventually be edited from,\nand it reads the same settings/constants the running code does so the page\ncan never show a rule we aren't actually enforcing.", "operationId": "get_feedback_automation_api_admin_feedback_automation_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackAutomationOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Feedback Automation", "tags": [ "admin" ] } }, "/api/admin/feedback/export.csv": { "get": { "description": "Same filters as the JSON list, one bounded fetch. Never exports images.", "operationId": "export_feedback_csv_api_admin_feedback_export_csv_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeedbackKind" }, { "type": "null" } ], "title": "Kind" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeedbackStatus" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeedbackSource" }, { "type": "null" } ], "title": "Source" } }, { "in": "query", "name": "rating", "required": false, "schema": { "anyOf": [ { "maximum": 5, "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Rating" } }, { "in": "query", "name": "has_screenshot", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Screenshot" } }, { "in": "query", "name": "organization_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Organization Id" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "newest", "pattern": "^(newest|oldest|rating_desc|rating_asc)$", "title": "Sort", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Export Feedback Csv", "tags": [ "admin" ] } }, "/api/admin/feedback/{feedback_id}": { "patch": { "operationId": "update_feedback_api_admin_feedback__feedback_id__patch", "parameters": [ { "in": "path", "name": "feedback_id", "required": true, "schema": { "format": "uuid", "title": "Feedback Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackUpdateIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminFeedbackOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Update Feedback", "tags": [ "admin" ] } }, "/api/admin/feedback/{feedback_id}/redact": { "post": { "description": "Erase the free text and any screenshot, keep the aggregate shape.", "operationId": "redact_feedback_api_admin_feedback__feedback_id__redact_post", "parameters": [ { "in": "path", "name": "feedback_id", "required": true, "schema": { "format": "uuid", "title": "Feedback Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Redact Feedback", "tags": [ "admin" ] } }, "/api/admin/feedback/{feedback_id}/screenshot": { "get": { "operationId": "get_feedback_screenshot_api_admin_feedback__feedback_id__screenshot_get", "parameters": [ { "in": "path", "name": "feedback_id", "required": true, "schema": { "format": "uuid", "title": "Feedback Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Feedback Screenshot", "tags": [ "admin" ] } }, "/api/admin/generation-failures": { "get": { "description": "Aggregated generation/LLM failure metrics with error grouping.", "operationId": "get_generation_failure_summary_api_admin_generation_failures_get", "parameters": [ { "in": "query", "name": "hours", "required": false, "schema": { "default": 24, "maximum": 168, "minimum": 1, "title": "Hours", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationFailureSummaryOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Generation Failure Summary", "tags": [ "admin", "admin" ] } }, "/api/admin/generations": { "get": { "operationId": "list_generations_api_admin_generations_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/GenerationStatus" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CreditAction" }, { "type": "null" } ], "title": "Kind" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminGenerationOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Generations", "tags": [ "admin" ] } }, "/api/admin/inquiry-subjects": { "get": { "description": "Inquiry subjects sorted by inquiry_count descending.\n\nThese are people searched for but absent from the dataset \u2014 a data-gap\nsignal. High inquiry_count means many orgs searched for the same person\nand found nothing.", "operationId": "list_inquiry_subjects_api_admin_inquiry_subjects_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminInquirySubjectOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Inquiry Subjects", "tags": [ "admin", "admin" ] } }, "/api/admin/inquiry-subjects/export.csv": { "get": { "operationId": "export_inquiry_subjects_csv_api_admin_inquiry_subjects_export_csv_get", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Export Inquiry Subjects Csv", "tags": [ "admin", "admin" ] } }, "/api/admin/inquiry-subjects/{subject_id}/searches": { "get": { "description": "Zero-result searches that match an inquiry subject's identity fields.\n\nUnknown subject ids return an empty page (not 404).", "operationId": "list_inquiry_subject_searches_api_admin_inquiry_subjects__subject_id__searches_get", "parameters": [ { "in": "path", "name": "subject_id", "required": true, "schema": { "format": "uuid", "title": "Subject Id", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminAllSearchOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Inquiry Subject Searches", "tags": [ "admin", "admin" ] } }, "/api/admin/invitations": { "get": { "operationId": "list_invitations_api_admin_invitations_get", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminInvitationOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Invitations", "tags": [ "admin" ] } }, "/api/admin/invitations/{invitation_id}": { "delete": { "operationId": "revoke_invitation_api_admin_invitations__invitation_id__delete", "parameters": [ { "in": "path", "name": "invitation_id", "required": true, "schema": { "format": "uuid", "title": "Invitation Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Revoke Invitation", "tags": [ "admin" ] } }, "/api/admin/metrics": { "get": { "operationId": "get_business_metrics_api_admin_metrics_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 90, "maximum": 365, "minimum": 7, "title": "Days", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminMetricsOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Business Metrics", "tags": [ "admin" ] } }, "/api/admin/organizations": { "get": { "operationId": "list_organizations_api_admin_organizations_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminOrgOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Organizations", "tags": [ "admin", "admin" ] } }, "/api/admin/organizations/merge": { "post": { "operationId": "merge_organizations_api_admin_organizations_merge_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeOrgsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeOrgsOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Merge Organizations", "tags": [ "admin", "admin" ] } }, "/api/admin/organizations/{org_id}/credits/adjust": { "post": { "operationId": "adjust_org_credits_api_admin_organizations__org_id__credits_adjust_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAdjustRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminWalletOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Adjust Org Credits", "tags": [ "admin" ] } }, "/api/admin/organizations/{org_id}/members": { "get": { "operationId": "list_organization_members_api_admin_organizations__org_id__members_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdminOrgMemberOut" }, "title": "Response List Organization Members Api Admin Organizations Org Id Members Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Organization Members", "tags": [ "admin", "admin" ] } }, "/api/admin/organizations/{org_id}/records/reinstate": { "post": { "operationId": "reinstate_org_records_api_admin_organizations__org_id__records_reinstate_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "alert_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Alert Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbuseReviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminOrgRecordsBlockOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reinstate Org Records", "tags": [ "admin" ] } }, "/api/admin/organizations/{org_id}/suspend": { "post": { "operationId": "suspend_organization_api_admin_organizations__org_id__suspend_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminOrgSuspensionOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Suspend Organization", "tags": [ "admin", "admin" ] } }, "/api/admin/organizations/{org_id}/unsuspend": { "post": { "operationId": "unsuspend_organization_api_admin_organizations__org_id__unsuspend_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminOrgSuspensionOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Unsuspend Organization", "tags": [ "admin", "admin" ] } }, "/api/admin/privacy-requests": { "get": { "operationId": "list_privacy_requests_api_admin_privacy_requests_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestPage" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Privacy Requests", "tags": [ "admin-privacy" ] } }, "/api/admin/privacy-requests/{request_id}": { "get": { "operationId": "get_privacy_request_api_admin_privacy_requests__request_id__get", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "format": "uuid", "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Privacy Request", "tags": [ "admin-privacy" ] } }, "/api/admin/privacy-requests/{request_id}/close": { "post": { "operationId": "close_privacy_request_api_admin_privacy_requests__request_id__close_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "format": "uuid", "title": "Request Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Close Privacy Request", "tags": [ "admin-privacy" ] } }, "/api/admin/privacy-requests/{request_id}/forward": { "post": { "operationId": "forward_privacy_request_api_admin_privacy_requests__request_id__forward_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "format": "uuid", "title": "Request Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForwardIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Forward Privacy Request", "tags": [ "admin-privacy" ] } }, "/api/admin/privacy-requests/{request_id}/fulfill": { "post": { "operationId": "fulfill_privacy_request_api_admin_privacy_requests__request_id__fulfill_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "format": "uuid", "title": "Request Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Fulfill Privacy Request", "tags": [ "admin-privacy" ] } }, "/api/admin/privacy-requests/{request_id}/reject": { "post": { "operationId": "reject_privacy_request_api_admin_privacy_requests__request_id__reject_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "format": "uuid", "title": "Request Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reject Privacy Request", "tags": [ "admin-privacy" ] } }, "/api/admin/privacy-requests/{request_id}/verify": { "post": { "operationId": "verify_privacy_request_api_admin_privacy_requests__request_id__verify_post", "parameters": [ { "in": "path", "name": "request_id", "required": true, "schema": { "format": "uuid", "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Verify Privacy Request", "tags": [ "admin-privacy" ] } }, "/api/admin/public-checks/purge": { "post": { "description": "Delete public identity-check rows older than the given timestamp.", "operationId": "purge_public_checks_api_admin_public_checks_purge_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgePublicChecksIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgePublicChecksOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Purge Public Checks", "tags": [ "admin", "admin" ] } }, "/api/admin/public-checks/stats": { "get": { "description": "Count + date range of anonymous identity-check audit rows.", "operationId": "public_check_stats_api_admin_public_checks_stats_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCheckStatsOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Public Check Stats", "tags": [ "admin", "admin" ] } }, "/api/admin/records/subjects": { "get": { "description": "Resolve audited record ids to who the person is (name, place, age).\n\nThe query-history tables show a GD- id per record view; this fills in the\nidentity line under it in one round trip per page instead of one record\ndetail fetch per row. No credits, no audit row \u2014 admin inspection only.", "operationId": "get_admin_record_subjects_api_admin_records_subjects_get", "parameters": [ { "in": "query", "name": "ids", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ids" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminRecordSubjectsOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Admin Record Subjects", "tags": [ "admin", "admin" ] } }, "/api/admin/records/{record_id}": { "get": { "description": "Full record detail for platform admins without org credit side effects.", "operationId": "get_admin_record_detail_api_admin_records__record_id__get", "parameters": [ { "in": "path", "name": "record_id", "required": true, "schema": { "title": "Record Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordDetailOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Admin Record Detail", "tags": [ "admin", "admin" ] } }, "/api/admin/search": { "get": { "description": "One-box lookup across users, organizations, and API keys (\u2318K palette).", "operationId": "global_search_api_admin_search_get", "parameters": [ { "in": "query", "name": "q", "required": true, "schema": { "maxLength": 120, "minLength": 2, "title": "Q", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminSearchOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Global Search", "tags": [ "admin" ] } }, "/api/admin/searches": { "get": { "description": "All records query events across all organizations, newest first.\n\nFilter by action type, surface, exact result count, or search org name / user email.", "operationId": "list_all_searches_api_admin_searches_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordQueryAction" }, { "type": "null" } ], "title": "Action" } }, { "in": "query", "name": "surface", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuerySurface" }, { "type": "null" } ], "title": "Surface" } }, { "in": "query", "name": "result_count", "required": false, "schema": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Result Count" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminAllSearchOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List All Searches", "tags": [ "admin", "admin" ] } }, "/api/admin/searches/{query_id}/clicks": { "get": { "description": "Click-through + friction flags for a search audit row.\n\nReturns VIEW events from the same org/user within 30 minutes of the\nsearch, distinct profile count, whether another search followed within\n15 minutes, and a primary outcome label. For a VIEW action itself,\nreturns the single viewed record.", "operationId": "get_search_outcome_api_admin_searches__query_id__clicks_get", "parameters": [ { "in": "path", "name": "query_id", "required": true, "schema": { "format": "uuid", "title": "Query Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchOutcomeOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Search Outcome", "tags": [ "admin", "admin" ] } }, "/api/admin/settings/exclusions": { "get": { "operationId": "list_metric_exclusions_api_admin_settings_exclusions_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricExclusionsOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Metric Exclusions", "tags": [ "admin" ] }, "post": { "operationId": "add_metric_exclusion_api_admin_settings_exclusions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddExclusionRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricExclusionOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Add Metric Exclusion", "tags": [ "admin" ] } }, "/api/admin/settings/exclusions/{exclusion_id}": { "delete": { "operationId": "remove_metric_exclusion_api_admin_settings_exclusions__exclusion_id__delete", "parameters": [ { "in": "path", "name": "exclusion_id", "required": true, "schema": { "format": "uuid", "title": "Exclusion Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Remove Metric Exclusion", "tags": [ "admin" ] } }, "/api/admin/settings/referral-program": { "get": { "operationId": "referral_program_settings_api_admin_settings_referral_program_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralSettingsOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Referral Program Settings", "tags": [ "admin" ] }, "post": { "operationId": "update_referral_program_settings_api_admin_settings_referral_program_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralSettingsUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralSettingsOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Update Referral Program Settings", "tags": [ "admin" ] } }, "/api/admin/stats": { "get": { "operationId": "get_stats_api_admin_stats_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminStats" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Stats", "tags": [ "admin" ] } }, "/api/admin/test-cases/miss-replay": { "get": { "operationId": "latest_miss_replay_api_admin_test_cases_miss_replay_get", "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Response Latest Miss Replay Api Admin Test Cases Miss Replay Get" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Latest Miss Replay", "tags": [ "admin", "admin" ] }, "post": { "description": "Enqueue the heavy replay of recent zero-result searches. The PII-free\nreport (source_query_id / shape / outcome / counts) lands at\nGET /miss-replay when it completes.", "operationId": "start_miss_replay_api_admin_test_cases_miss_replay_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MissReplayIn" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Start Miss Replay Api Admin Test Cases Miss Replay Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Start Miss Replay", "tags": [ "admin", "admin" ] } }, "/api/admin/test-cases/runs": { "get": { "description": "Run history, newest first \u2014 the trend view for recall/precision.", "operationId": "list_runs_api_admin_test_cases_runs_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RunOut" }, "title": "Response List Runs Api Admin Test Cases Runs Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Runs", "tags": [ "admin", "admin" ] }, "post": { "operationId": "create_run_api_admin_test_cases_runs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRunIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Run", "tags": [ "admin", "admin" ] } }, "/api/admin/test-cases/runs/latest": { "get": { "operationId": "latest_run_api_admin_test_cases_runs_latest_get", "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RunOut" }, { "type": "null" } ], "title": "Response Latest Run Api Admin Test Cases Runs Latest Get" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Latest Run", "tags": [ "admin", "admin" ] } }, "/api/admin/test-cases/runs/{run_id}": { "get": { "operationId": "get_run_api_admin_test_cases_runs__run_id__get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Run", "tags": [ "admin", "admin" ] } }, "/api/admin/test-cases/runs/{run_id}/cases": { "get": { "operationId": "list_cases_api_admin_test_cases_runs__run_id__cases_get", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "format": "uuid", "title": "Run Id", "type": "string" } }, { "in": "query", "name": "failed", "required": false, "schema": { "default": false, "title": "Failed", "type": "boolean" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 200, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CaseOut" }, "title": "Response List Cases Api Admin Test Cases Runs Run Id Cases Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Cases", "tags": [ "admin", "admin" ] } }, "/api/admin/users": { "get": { "operationId": "list_users_api_admin_users_get", "parameters": [ { "in": "query", "name": "search", "required": false, "schema": { "default": "", "maxLength": 320, "title": "Search", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page_AdminUserOut_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Users", "tags": [ "admin", "admin" ] } }, "/api/admin/users/{user_id}/deactivate": { "post": { "operationId": "deactivate_user_api_admin_users__user_id__deactivate_post", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Deactivate User", "tags": [ "admin", "admin" ] } }, "/api/admin/users/{user_id}/impersonate": { "post": { "description": "Mint a short-lived access token for the target user (no refresh token \u2014\nthe impersonated session simply expires). Audit-logged.", "operationId": "impersonate_user_api_admin_users__user_id__impersonate_post", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImpersonationOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Impersonate User", "tags": [ "admin", "admin" ] } }, "/api/admin/users/{user_id}/organizations": { "get": { "description": "List all organizations a user belongs to, with their role, credit\nbalance, and open holds in each.", "operationId": "list_user_organizations_api_admin_users__user_id__organizations_get", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AdminUserOrgOut" }, "title": "Response List User Organizations Api Admin Users User Id Organizations Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List User Organizations", "tags": [ "admin", "admin" ] } }, "/api/admin/users/{user_id}/reactivate": { "post": { "operationId": "reactivate_user_api_admin_users__user_id__reactivate_post", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reactivate User", "tags": [ "admin", "admin" ] } }, "/api/admin/users/{user_id}/signout-everywhere": { "post": { "operationId": "signout_user_everywhere_api_admin_users__user_id__signout_everywhere_post", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminUserOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Signout User Everywhere", "tags": [ "admin", "admin" ] } }, "/api/auth/change-password": { "post": { "description": "Change password while signed in. Revokes every other session.", "operationId": "change_password_api_auth_change_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Change Password", "tags": [ "auth" ] } }, "/api/auth/forgot-password": { "post": { "description": "Always 204 \u2014 whether the account exists is never revealed.", "operationId": "forgot_password_api_auth_forgot_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Forgot Password", "tags": [ "auth" ] } }, "/api/auth/login": { "post": { "operationId": "login_api_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Login", "tags": [ "auth" ] } }, "/api/auth/logout": { "post": { "operationId": "logout_api_auth_logout_post", "responses": { "204": { "description": "Successful Response" } }, "summary": "Logout", "tags": [ "auth" ] } }, "/api/auth/me": { "get": { "operationId": "me_api_auth_me_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Me", "tags": [ "auth" ] }, "patch": { "description": "Partial profile update (name, marketing consent \u2014 only provided fields).", "operationId": "update_me_api_auth_me_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Update Me", "tags": [ "auth" ] } }, "/api/auth/refresh": { "post": { "operationId": "refresh_api_auth_refresh_post", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } }, "description": "Successful Response" } }, "summary": "Refresh", "tags": [ "auth" ] } }, "/api/auth/register": { "post": { "operationId": "register_api_auth_register_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Register", "tags": [ "auth" ] } }, "/api/auth/resend-verification": { "post": { "operationId": "resend_verification_api_auth_resend_verification_post", "responses": { "204": { "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Resend Verification", "tags": [ "auth" ] } }, "/api/auth/reset-password": { "post": { "operationId": "reset_password_api_auth_reset_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Reset Password", "tags": [ "auth" ] } }, "/api/auth/verify-email": { "post": { "operationId": "verify_email_api_auth_verify_email_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Verify Email", "tags": [ "auth" ] } }, "/api/billing/credits/packs": { "get": { "operationId": "list_credit_packs_api_billing_credits_packs_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CreditPackOut" }, "title": "Response List Credit Packs Api Billing Credits Packs Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Credit Packs", "tags": [ "billing" ] } }, "/api/consent": { "get": { "operationId": "current_consent_api_consent_get", "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConsentOut" }, { "type": "null" } ], "title": "Response Current Consent Api Consent Get" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Current Consent", "tags": [ "consent" ] }, "post": { "operationId": "record_consent_api_consent_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Record Consent", "tags": [ "consent" ] } }, "/api/credits/actions": { "get": { "operationId": "list_action_costs_api_credits_actions_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ActionCostOut" }, "title": "Response List Action Costs Api Credits Actions Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Action Costs", "tags": [ "credits" ] } }, "/api/feedback": { "post": { "operationId": "submit_feedback_api_feedback_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Submit Feedback", "tags": [ "feedback" ] } }, "/api/health": { "get": { "description": "Readiness probe \u2014 gates zero-downtime deploys, so it must verify the DB.", "operationId": "health_api_health_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Health Api Health Get", "type": "object" } } }, "description": "Successful Response" } }, "summary": "Health", "tags": [ "health" ] } }, "/api/invitations/accept": { "post": { "operationId": "accept_invitation_api_invitations_accept_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptInviteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWithRole" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Accept Invitation", "tags": [ "organizations" ] } }, "/api/me/feedback-prompt": { "delete": { "description": "Clear prompt state so the popup can be demoed or re-tested.", "operationId": "reset_prompt_state_api_me_feedback_prompt_delete", "responses": { "204": { "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reset Prompt State", "tags": [ "feedback" ] }, "get": { "operationId": "read_prompt_state_api_me_feedback_prompt_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackPromptOut" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Read Prompt State", "tags": [ "feedback" ] }, "put": { "operationId": "record_prompt_decision_api_me_feedback_prompt_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackPromptIn" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Record Prompt Decision", "tags": [ "feedback" ] } }, "/api/me/tours": { "get": { "operationId": "list_seen_tours_api_me_tours_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response List Seen Tours Api Me Tours Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Seen Tours", "tags": [ "onboarding" ] } }, "/api/me/tours/{tour_key}": { "delete": { "operationId": "reset_tour_api_me_tours__tour_key__delete", "parameters": [ { "in": "path", "name": "tour_key", "required": true, "schema": { "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9:_-]+$", "title": "Tour Key", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reset Tour", "tags": [ "onboarding" ] }, "put": { "operationId": "mark_tour_seen_api_me_tours__tour_key__put", "parameters": [ { "in": "path", "name": "tour_key", "required": true, "schema": { "maxLength": 64, "minLength": 1, "pattern": "^[a-z0-9:_-]+$", "title": "Tour Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TourSeenIn" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Mark Tour Seen", "tags": [ "onboarding" ] } }, "/api/orgs": { "get": { "operationId": "list_my_orgs_api_orgs_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/OrgWithRole" }, "title": "Response List My Orgs Api Orgs Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List My Orgs", "tags": [ "organizations" ] }, "post": { "operationId": "create_org_api_orgs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWithRole" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Org", "tags": [ "organizations" ] } }, "/api/orgs/{org_id}": { "delete": { "operationId": "delete_org_api_orgs__org_id__delete", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Org", "tags": [ "organizations" ] }, "get": { "operationId": "get_org_api_orgs__org_id__get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWithRole" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Org", "tags": [ "organizations" ] }, "patch": { "operationId": "update_org_api_orgs__org_id__patch", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWithRole" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Update Org", "tags": [ "organizations" ] } }, "/api/orgs/{org_id}/api-keys": { "get": { "operationId": "list_api_keys_api_orgs__org_id__api_keys_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiKeyOut" }, "title": "Response List Api Keys Api Orgs Org Id Api Keys Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Api Keys", "tags": [ "api-keys" ] }, "post": { "operationId": "create_api_key_api_orgs__org_id__api_keys_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreated" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Api Key", "tags": [ "api-keys" ] } }, "/api/orgs/{org_id}/api-keys/{key_id}": { "delete": { "operationId": "revoke_api_key_api_orgs__org_id__api_keys__key_id__delete", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "path", "name": "key_id", "required": true, "schema": { "format": "uuid", "title": "Key Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Revoke Api Key", "tags": [ "api-keys" ] } }, "/api/orgs/{org_id}/billing": { "get": { "operationId": "get_billing_api_orgs__org_id__billing_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingAccountOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Billing", "tags": [ "billing" ] } }, "/api/orgs/{org_id}/billing/credits/checkout": { "post": { "operationId": "create_credit_pack_checkout_api_orgs__org_id__billing_credits_checkout_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditPackCheckoutRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Credit Pack Checkout", "tags": [ "billing" ] } }, "/api/orgs/{org_id}/billing/invoices": { "get": { "operationId": "list_invoices_api_orgs__org_id__billing_invoices_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/InvoiceOut" }, "title": "Response List Invoices Api Orgs Org Id Billing Invoices Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Invoices", "tags": [ "billing" ] } }, "/api/orgs/{org_id}/billing/portal": { "post": { "operationId": "create_portal_api_orgs__org_id__billing_portal_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Portal", "tags": [ "billing" ] } }, "/api/orgs/{org_id}/credits": { "get": { "operationId": "get_wallet_api_orgs__org_id__credits_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Wallet", "tags": [ "credits" ] } }, "/api/orgs/{org_id}/credits/history": { "get": { "operationId": "get_history_api_orgs__org_id__credits_history_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get History", "tags": [ "credits" ] } }, "/api/orgs/{org_id}/credits/member-limits": { "get": { "operationId": "list_member_limits_api_orgs__org_id__credits_member_limits_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MemberLimitOut" }, "title": "Response List Member Limits Api Orgs Org Id Credits Member Limits Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Member Limits", "tags": [ "credits" ] } }, "/api/orgs/{org_id}/credits/member-limits/{user_id}": { "delete": { "operationId": "clear_member_limit_api_orgs__org_id__credits_member_limits__user_id__delete", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Clear Member Limit", "tags": [ "credits" ] }, "put": { "operationId": "set_member_limit_api_orgs__org_id__credits_member_limits__user_id__put", "parameters": [ { "in": "path", "name": "user_id", "required": true, "schema": { "format": "uuid", "title": "User Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberLimitIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberLimitOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Set Member Limit", "tags": [ "credits" ] } }, "/api/orgs/{org_id}/credits/usage": { "get": { "description": "Credits spent this period, grouped by actor (member or API key).\n\nMember-visible: /credits/history already exposes per-user emails and\namounts to every member, and members should see their own limit progress.", "operationId": "get_usage_api_orgs__org_id__credits_usage_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "period", "required": false, "schema": { "anyOf": [ { "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "type": "string" }, { "type": "null" } ], "title": "Period" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Usage", "tags": [ "credits" ] } }, "/api/orgs/{org_id}/domain": { "put": { "operationId": "set_org_domain_api_orgs__org_id__domain_put", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgDomainUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgWithRole" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Set Org Domain", "tags": [ "organizations" ] } }, "/api/orgs/{org_id}/generations": { "get": { "operationId": "list_generations_api_orgs__org_id__generations_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GenerationOut" }, "title": "Response List Generations Api Orgs Org Id Generations Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Generations", "tags": [ "generations" ] }, "post": { "operationId": "create_generation_api_orgs__org_id__generations_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGenerationRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Generation", "tags": [ "generations" ] } }, "/api/orgs/{org_id}/generations/{generation_id}": { "delete": { "operationId": "delete_generation_api_orgs__org_id__generations__generation_id__delete", "parameters": [ { "in": "path", "name": "generation_id", "required": true, "schema": { "format": "uuid", "title": "Generation Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Generation", "tags": [ "generations" ] }, "get": { "operationId": "get_generation_api_orgs__org_id__generations__generation_id__get", "parameters": [ { "in": "path", "name": "generation_id", "required": true, "schema": { "format": "uuid", "title": "Generation Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Generation", "tags": [ "generations" ] } }, "/api/orgs/{org_id}/generations/{generation_id}/cancel": { "post": { "operationId": "cancel_generation_api_orgs__org_id__generations__generation_id__cancel_post", "parameters": [ { "in": "path", "name": "generation_id", "required": true, "schema": { "format": "uuid", "title": "Generation Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerationOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Cancel Generation", "tags": [ "generations" ] } }, "/api/orgs/{org_id}/generations/{generation_id}/file": { "get": { "operationId": "download_generation_api_orgs__org_id__generations__generation_id__file_get", "parameters": [ { "in": "path", "name": "generation_id", "required": true, "schema": { "format": "uuid", "title": "Generation Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Download Generation", "tags": [ "generations" ] } }, "/api/orgs/{org_id}/invitations": { "get": { "operationId": "list_invitations_api_orgs__org_id__invitations_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/InvitationOut" }, "title": "Response List Invitations Api Orgs Org Id Invitations Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Invitations", "tags": [ "organizations" ] }, "post": { "operationId": "create_invitation_api_orgs__org_id__invitations_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Invitation", "tags": [ "organizations" ] } }, "/api/orgs/{org_id}/invitations/{invitation_id}": { "delete": { "operationId": "revoke_invitation_api_orgs__org_id__invitations__invitation_id__delete", "parameters": [ { "in": "path", "name": "invitation_id", "required": true, "schema": { "format": "uuid", "title": "Invitation Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Revoke Invitation", "tags": [ "organizations" ] } }, "/api/orgs/{org_id}/llm/calls": { "get": { "operationId": "list_llm_calls_api_orgs__org_id__llm_calls_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/LlmCallOut" }, "title": "Response List Llm Calls Api Orgs Org Id Llm Calls Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Llm Calls", "tags": [ "llm" ] } }, "/api/orgs/{org_id}/llm/calls/{call_id}": { "get": { "operationId": "get_llm_call_api_orgs__org_id__llm_calls__call_id__get", "parameters": [ { "in": "path", "name": "call_id", "required": true, "schema": { "format": "uuid", "title": "Call Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LlmCallOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Llm Call", "tags": [ "llm" ] } }, "/api/orgs/{org_id}/llm/complete": { "post": { "operationId": "complete_text_api_orgs__org_id__llm_complete_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LlmCallOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Complete Text", "tags": [ "llm" ] } }, "/api/orgs/{org_id}/members": { "get": { "operationId": "list_members_api_orgs__org_id__members_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/MemberOut" }, "title": "Response List Members Api Orgs Org Id Members Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Members", "tags": [ "organizations" ] } }, "/api/orgs/{org_id}/members/{membership_id}": { "delete": { "operationId": "remove_member_api_orgs__org_id__members__membership_id__delete", "parameters": [ { "in": "path", "name": "membership_id", "required": true, "schema": { "format": "uuid", "title": "Membership Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Remove Member", "tags": [ "organizations" ] }, "patch": { "operationId": "change_member_role_api_orgs__org_id__members__membership_id__patch", "parameters": [ { "in": "path", "name": "membership_id", "required": true, "schema": { "format": "uuid", "title": "Membership Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Change Member Role", "tags": [ "organizations" ] } }, "/api/orgs/{org_id}/properties/by-address": { "get": { "description": "Reverse address search: who owns this address + property details.", "operationId": "properties_at_address_api_orgs__org_id__properties_by_address_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "house_number", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "House Number" } }, { "in": "query", "name": "street_name", "required": false, "schema": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Street Name" } }, { "in": "query", "name": "street_suffix", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Street Suffix" } }, { "in": "query", "name": "unit_number", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Unit Number" } }, { "in": "query", "name": "city", "required": false, "schema": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "City" } }, { "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "State" } }, { "in": "query", "name": "zip", "required": false, "schema": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Zip" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 25, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyPageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Properties At Address", "tags": [ "properties" ] } }, "/api/orgs/{org_id}/records": { "get": { "operationId": "search_records_api_orgs__org_id__records_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "in": "query", "name": "city", "required": false, "schema": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "City" } }, { "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "State" } }, { "in": "query", "name": "zip", "required": false, "schema": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Zip" } }, { "in": "query", "name": "email", "required": false, "schema": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Email" } }, { "in": "query", "name": "phone", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Phone" } }, { "in": "query", "name": "dob", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Dob" } }, { "in": "query", "name": "age_min", "required": false, "schema": { "anyOf": [ { "maximum": 130, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Age Min" } }, { "in": "query", "name": "age_max", "required": false, "schema": { "anyOf": [ { "maximum": 130, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Age Max" } }, { "in": "query", "name": "deceased", "required": false, "schema": { "anyOf": [ { "maxLength": 8, "type": "string" }, { "type": "null" } ], "title": "Deceased" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 25, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordPageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Search Records", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/activity": { "get": { "description": "Customer-facing activity log \u2014 who did what when in this org.\n\nRecord accesses carry a `subject` (who the record was about) resolved\nlive against the dataset, masked to match the access: full name + city\nfor a charged view, name + state only for a masked preview.", "operationId": "list_activity_api_orgs__org_id__records_activity_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordQueryAction" }, { "type": "null" } ], "title": "Action" } }, { "in": "query", "name": "surface", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuerySurface" }, { "type": "null" } ], "title": "Surface" } }, { "in": "query", "name": "has_results", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Results" } }, { "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "newest", "pattern": "^(newest|oldest)$", "title": "Sort", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Page Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityPageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Activity", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/activity/export.csv": { "get": { "description": "CSV of the filtered activity log (capped at EXPORT_CAP).\n\nSubject columns are filled for up to SUBJECT_EXPORT_CAP distinct people\n(each batch is a dataset round trip); past that they stay blank and\nrecord_id still identifies the row.", "operationId": "export_activity_csv_api_orgs__org_id__records_activity_export_csv_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordQueryAction" }, { "type": "null" } ], "title": "Action" } }, { "in": "query", "name": "surface", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuerySurface" }, { "type": "null" } ], "title": "Surface" } }, { "in": "query", "name": "has_results", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Has Results" } }, { "in": "query", "name": "user_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "User Id" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } }, { "in": "query", "name": "sort", "required": false, "schema": { "default": "newest", "pattern": "^(newest|oldest)$", "title": "Sort", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Export Activity Csv", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/at-address": { "get": { "description": "People-at-address (household): inverted index over address history.\n\nReturns everyone who has lived at the property, tagged current vs\nhistorical from each person's most-recent address slot.", "operationId": "people_at_address_api_orgs__org_id__records_at_address_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "house_number", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "House Number" } }, { "in": "query", "name": "street_name", "required": false, "schema": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "Street Name" } }, { "in": "query", "name": "street_suffix", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Street Suffix" } }, { "in": "query", "name": "unit_number", "required": false, "schema": { "anyOf": [ { "maxLength": 32, "type": "string" }, { "type": "null" } ], "title": "Unit Number" } }, { "in": "query", "name": "city", "required": false, "schema": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ], "title": "City" } }, { "in": "query", "name": "state", "required": false, "schema": { "anyOf": [ { "maxLength": 2, "type": "string" }, { "type": "null" } ], "title": "State" } }, { "in": "query", "name": "zip", "required": false, "schema": { "anyOf": [ { "maxLength": 10, "type": "string" }, { "type": "null" } ], "title": "Zip" } }, { "in": "query", "name": "current_only", "required": false, "schema": { "default": false, "title": "Current Only", "type": "boolean" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 25, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HouseholdPageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "People At Address", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/check": { "post": { "description": "Authenticated Match / No match / Needs review check \u2014 free (no credit charge).", "operationId": "identity_check_api_orgs__org_id__records_check_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityCheckIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityCheckOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Identity Check", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/recent": { "get": { "description": "Org search/check history for the dashboard \u2014 no credit charge.\n\nSame member-vs-admin scoping as /records/activity: members see only\ntheir own rows; admins/owners see the whole org. Response schema is\nunchanged so the dashboard widget keeps working.", "operationId": "recent_queries_api_orgs__org_id__records_recent_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 50, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecentQueriesOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Recent Queries", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/{record_id}": { "get": { "operationId": "get_record_api_orgs__org_id__records__record_id__get", "parameters": [ { "in": "path", "name": "record_id", "required": true, "schema": { "title": "Record Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "city", "required": false, "schema": { "anyOf": [ { "maxLength": 1, "type": "string" }, { "type": "null" } ], "title": "City" } }, { "in": "header", "name": "x-confirm-shared-access", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Confirm-Shared-Access" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordDetailOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Record", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/{record_id}/access-info": { "get": { "description": "Check whether this org has previously viewed a record \u2014 no credit charge.", "operationId": "record_access_info_api_orgs__org_id__records__record_id__access_info_get", "parameters": [ { "in": "path", "name": "record_id", "required": true, "schema": { "title": "Record Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordAccessInfoOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Record Access Info", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/{record_id}/preview": { "get": { "description": "Free masked profile preview \u2014 structure and counts visible, contact\ndetails redacted. City is revealed only when ``city=1`` (the caller\nsearched by city).", "operationId": "preview_record_api_orgs__org_id__records__record_id__preview_get", "parameters": [ { "in": "path", "name": "record_id", "required": true, "schema": { "title": "Record Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "city", "required": false, "schema": { "anyOf": [ { "maxLength": 1, "type": "string" }, { "type": "null" } ], "title": "City" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordDetailOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Preview Record", "tags": [ "records" ] } }, "/api/orgs/{org_id}/records/{record_id}/properties": { "get": { "description": "Properties owned by a person (consumer record).", "operationId": "properties_for_person_api_orgs__org_id__records__record_id__properties_get", "parameters": [ { "in": "path", "name": "record_id", "required": true, "schema": { "title": "Record Id", "type": "string" } }, { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 25, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyPageOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Properties For Person", "tags": [ "properties" ] } }, "/api/orgs/{org_id}/referrals": { "get": { "operationId": "referral_summary_api_orgs__org_id__referrals_get", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralSummaryOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Referral Summary", "tags": [ "referrals" ] } }, "/api/orgs/{org_id}/referrals/invitations": { "post": { "operationId": "send_referral_invitation_api_orgs__org_id__referrals_invitations_post", "parameters": [ { "in": "path", "name": "org_id", "required": true, "schema": { "format": "uuid", "title": "Org Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralEmailRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralEmailSent" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Send Referral Invitation", "tags": [ "referrals" ] } }, "/api/privacy/requests": { "post": { "operationId": "submit_privacy_request_api_privacy_requests_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestSubmitIn" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyRequestSubmitOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Submit Privacy Request", "tags": [ "privacy" ] } }, "/api/properties/coverage": { "get": { "description": "Public, unauthenticated: which counties have property data.", "operationId": "property_coverage_api_properties_coverage_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageOut" } } }, "description": "Successful Response" } }, "summary": "Property Coverage", "tags": [ "properties-public" ] } }, "/api/records/check": { "post": { "description": "Free coarse check \u2014 outcome + signals only. No record id, no teaser.\n\nOne check per IP, then one every hour (slowapi counter in Valkey; the\n429 handler emits Retry-After and the homepage freezes the form on it).\nEach accepted check writes an org-less audit row (surface=public) with\nIP, user agent, and the full input PII (periodically purged via the\nadmin public-checks page) \u2014 rejected attempts 429 before the handler\nand stay visible in proxy logs only.\n\nAccepts email and/or phone. The marketing form may send a single contact\nvalue in ``email`` (if it looks like an email) or ``phone`` otherwise \u2014\nthe frontend splits before calling.", "operationId": "public_identity_check_api_records_check_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityCheckIn" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityCheckPublicOut" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Public Identity Check", "tags": [ "records-public" ] } } }, "servers": [ { "url": "https://coverfi.com" } ] }