API Endpoint Catalog
These v3 document operations work with the linked organization’s native faxes after successful self-serve activation (where offered for your account) or coordinated enterprise enrollment. Signup alone does not enable v3. Live developer keys support the listed document operations; test keys support simulated sent-fax uploads, listing and detail. Received-fax operations require live credentials.
Endpoints
Paths below are relative to /api/v3. Requests use snake_case fields; JSON responses use camelCase. Fax IDs are the opaque sendToken values, not database IDs.
| Method and path | Result |
|---|---|
| POST /sent_faxes | Upload a file and send; 201 with faxId. |
| GET /sent_faxes | Organization sent deliveries in sentFaxes plus pagination meta. |
| GET /sent_faxes/:id | Top-level fax details/status and secureLink. |
| GET /received_faxes | Native received list in receivedFaxes plus pagination meta. |
| GET /received_faxes/:id | receivedFax object with pdfDownloadUrl. |
| PATCH /received_faxes/:id | Archive/unarchive; receivedFax without a download URL. |
See Sent Faxes and Received Faxes for request fields, filters, response shapes, downloads and archive behavior.
Organization number provisioning
POST /api/v3/fax_numbers rents a billable organization-owned number for eligible existing customers using a live developer key. Self-serve additional-number purchases are denied. See Fax Numbers for eligibility, the flat request body and no-retry guidance for uncertain rentals.
The OpenAPI description currently covers v2. Its generated legacy endpoint catalog remains available for existing integrations.