FxFaximus Developers
Production APIPortal

Fax Inbox

List received faxes, read inbox records, and request short-lived URLs for inbound fax documents.

StartAuthenticationDocumentsFax JobsInboxEmail FaxWebhooksErrorsOpenAPI

Reference

Inbox

GET/v1/inboxList inbound faxesRead inbound fax metadata, caller ID, receiving fax number, received time, and document summary.fax:read

Read inbound fax metadata, caller ID, receiving fax number, received time, and document summary.

Required scope
fax:read
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
listInbox
Response example
{ "items": [{ "inboundFaxId": "66666666-6666-4666-8666-666666666666", "calledDidE164": "+18646720349" }], "nextCursor": null }
GET/v1/inbox/{inboundFaxId}Get an inbound faxRetrieve a single inbound fax record and customer-safe document metadata.fax:read

Retrieve a single inbound fax record and customer-safe document metadata.

Required scope
fax:read
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
getInboxItem
Response example
{ "inboundFaxId": "66666666-6666-4666-8666-666666666666", "importState": "imported", "document": { "documentId": "..." } }
POST/v1/inbox/{inboundFaxId}/document-accessCreate inbound document accessCreate a short-lived download URL for an inbound fax document.fax:read

Create a short-lived download URL for an inbound fax document.

Required scope
fax:read
Authentication
Bearer API key or customer session; account roles and scopes also apply
Base URL
https://api.faximus.io
OpenAPI operation
createInboundDocumentAccess
Response example
{ "documentAccessUrl": "https://...", "expiresAt": "2026-06-01T18:00:00.000Z" }