List and filter faxes
List sent and received faxes. Omit all filters to return every available fax. Use folder to select INBOX, OUTBOX, or TRASH; direction to select inbound or outbound faxes; fax_number to match a sender or recipient fax number; and from_date / to_date to select an inclusive creation-time range. Folder and direction filters are case-insensitive.
Results use zero-based page and size pagination and include data, page, size, total_pages, and total_count. Fax responses use status values received, sending, delivered, and failed; direction values inbound and outbound; and folder values INBOX, OUTBOX, and TRASH. An inverted date range returns 422 Unprocessable Entity.
Request
- Base URL: https://api.efax.com
- URL: https://api.efax.com/v1/faxes
- Auth: HTTP bearer
Query parameters
Folder/view to return. Matching is case-insensitive. Omit to include all folders.
Transmission direction. Matching is case-insensitive. Omit to include both directions.
Originating or destination fax number to match, in E.164 format.
Inclusive lower bound of the creation-time window, as an RFC 3339 offset date-time.
Inclusive upper bound of the creation-time window, as an RFC 3339 offset date-time.
Zero-based page index. Defaults to 0 when omitted.
Maximum items per page. Defaults to 20; allowed range is 1 through 100.
Response
A page of faxes matching the supplied filters.
Changes
No recorded changes to this operation across all 1 revision of this API.