DevelopersAPI Reference
Fax
List inbound, outbound, and queued faxes for a tenant.
Fax
GET /api/v1/fax
| Permission | fax |
| User header | Optional (not used to filter the list) |
type | Meaning |
|---|---|
inbox (default) | Received faxes |
sent | Outbound faxes |
queue | Outbound queue |
If the phone system is not linked, the API returns TENANT_NOT_CONFIGURED or PBX_NOT_CONFIGURED.
data includes faxes[] and the type you requested. Each fax has id, date, caller fields, destination, pages, status, retryCount, and sender when attribution is available.