API schemas reference
Updated
173 named objects, as the Fax for Agents API sends and accepts them, from the OpenAPI document version 1.20.0, snapshot of 2026-11-13. They are on 3 pages by the first letter of the name. The operations that use them are in the full reference, one page per group.
A to E
54 objects, from Accepted to ExtractionSchemaList, with the type of each field.
- Accepted
- Agent
- AgentActivity
- AgentActivityPage
- AgentCreate
- AgentKeyCreate
- AgentList
- AgentUpdate
- ApiKey
- ApiKeyCreate
- ApiKeyList
- ApiKeyWithSecret
- ApprovalDecision
- ApprovalRequest
- ApprovalRequestCreate
- ApprovalRequestPage
- Attempt
- AttemptPage
- AutoSendSetting
- AutoSendUpdate
- AutoTopup
- AutoTopupCreate
- AutoTopupList
- Balance
- BillingSettings
- BillingSettingsPatch
- Budget
- BudgetCreate
- BudgetList
- BudgetPatch
- Capabilities
- ClassificationCreate
- Correction
- CorrectionCreate
- Coverage
- Deleted
- Delivery
- DeliveryPage
- Document
- DocumentCreate
- DocumentPage
- DocumentPages
- DocumentValidation
- EffectivePolicies
- ErrorBody
- ErrorEnvelope
- Event
- EventPage
- Extraction
- ExtractionCreate
- ExtractionPage
- ExtractionPageList
- ExtractionSchema
- ExtractionSchemaList
F to O
55 objects, from FaxCreate to faxforagents__auth__schemas__Me, with the type of each field.
- FaxCreate
- FaxJob
- FaxJobPage
- Grant
- GrantList
- InboxItemDetail
- InboxPage
- InboxUpdate
- Inventory
- InventoryNumber
- Invitation
- InvitationCreate
- InvitationList
- Invoice
- InvoicePage
- LedgerEntry
- LedgerPage
- MagicLinkRequest
- Member
- MemberList
- MemberPatch
- Number
- NumberList
- NumberOrder
- NumberOrderCreate
- NumberOrderList
- NumberUpdate
- OAuthConsent
- OAuthConsentAutoSend
- OAuthConsentClient
- OAuthConsentDecision
- OAuthConsentOrganization
- OAuthRedirect
- OneTimeCard
- OneTimeCheckout
- OneTimeConfig
- OneTimeConfirm
- OneTimeConfirmSummary
- OneTimeConfirmed
- OneTimeFromQuote
- OneTimeJob
- OneTimeOrder
- OneTimeOrderCreated
- OneTimeOrderPage
- OneTimePrice
- OneTimeQueue
- OneTimeRoute
- Organization
- OrganizationList
- OrganizationPatch
- OrganizationSummary
- faxforagents__api__routes__inbox__InboxItem
- faxforagents__api__schemas__InboxItem
- faxforagents__api__schemas__Me
- faxforagents__auth__schemas__Me
P to Z
64 objects, from PagePreview to WebhookWithSecret, with the type of each field.
- PagePreview
- Passkey
- PasskeyList
- PasskeyLoginVerify
- PasskeyRegisterVerify
- Policy
- PolicyCreate
- PolicyEvaluation
- PolicyEvaluationCreate
- PolicyList
- PolicyUpdate
- PolicyVersion
- PolicyVersionList
- PortOrder
- PortOrderCreate
- PortOrderList
- PortOutRequestCreate
- PortabilityCheck
- PortabilityCheckCreate
- PortalSession
- Providers
- Quote
- QuoteCreate
- Reauth
- Receipt
- ReleaseRequest
- Requested
- ReviewSignIn
- Revoked
- SandboxFixture
- SandboxInboundCreate
- SandboxReset
- SandboxScenarioCreate
- SandboxScenarios
- SchemaCreate
- SenderVerification
- SenderVerificationCreate
- Sent
- ServiceStatus
- SessionInfo
- SessionList
- SessionOut
- SignedUrl
- Subscription
- SubscriptionCheckout
- SubscriptionList
- SummaryCreate
- SwitchOrganization
- TopupCreate
- TopupSession
- TopupSessionPage
- UploadComplete
- UploadCreate
- UploadSession
- UsageExport
- UsageExportCreate
- UsageItem
- UsageReport
- UserOut
- Webhook
- WebhookCreate
- WebhookList
- WebhookUpdate
- WebhookWithSecret