Skip to main content
GET
Time range (after / before)
Both values are UTC (YYYY-MM-DD HH:MM:SS) and exclusive. To match a local calendar day, convert that day to a UTC window using the correct time zone (daylight-saving rules change the offset).
Pagination
Each call returns at most 50 records. The JSON body is data.records only; there is no has_more flag. If you receive 50 records, fetch the next page with offset, or use a narrower time window. Because before is exclusive, records that share the same second as your upper bound are omitted.
Categories (default: inbox)
  • inbox — received faxes that completed or were only partly received; excludes deleted items and user-marked spam (unless you filter by status).
  • sent — outgoing faxes.
  • spam — spam faxes.
Web export vs API
CSV exports from the web app show local time. This API filters on UTC. Convert local days to UTC windows when reconciling with an export.

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Path Parameters

user_id
string
default:self
required

User ID. Use 'self' for your own account, or provide a specific user ID for corporate member accounts.

Query Parameters

category
enum<string>
default:inbox

Optional. inbox (default), sent, or spam. See Listing tips below for what each includes.

Available options:
inbox,
sent,
spam
after
string

Optional UTC lower bound (YYYY-MM-DD HH:MM:SS). Exclusive: records on this exact second are not included.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}
before
string

Optional UTC upper bound (YYYY-MM-DD HH:MM:SS). Exclusive: records on this exact second are not included.

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}
limit
integer
default:50

Optional. Maximum records per request, 1–50 (default 50). The response does not include a has_more field.

Required range: 1 <= x <= 50
offset
integer
default:0

Optional. Number of matching records to skip (default 0). Use with limit for pagination.

Required range: 0 <= x <= 2147483647
sort_by
enum<string>

Field to sort the results by. Valid values: date, from, to, comment, pages. Optional.

Available options:
date,
from,
to,
comment,
pages
order
enum<string>
default:asc

Order of the sorting. Valid values: asc for ascending, desc for descending. Optional, defaults to 'asc'.

Available options:
asc,
desc
in_progress
boolean
default:false

Return in-progress incoming faxes. Optional, defaults to false. This functionality can be enabled on request.

status
enum<string>[]

Filter by transmission status. Comma-separated.

See Fax Error Statuses for the full list and meanings.

Available options:
success,
partially_sent,
partially_received,
in_progress,
insufficient_credit,
failed,
failed_internal_process_error,
failed_user_busy,
failed_no_answer,
failed_unallocated_number,
failed_office_converter_issue,
failed_separate_file_pages_issue,
failed_render_header_issue,
failed_invalid_number_format,
failed_mimetype_not_supported,
failed_destination_not_supported,
failed_image_preparation,
failed_to_send,
failed_origination_unknown,
failed_no_origination,
failed_no_user_response,
failed_call_rejected,
failed_exchange_routing_error,
failed_no_route_destination,
failed_normal_circuit_congestion,
failed_recovery_on_timer_expire,
failed_requested_chan_unavail,
failed_network_out_of_order,
failed_destination_out_of_order,
failed_normal_temporary_failure,
failed_unknown_converter_issue,
failed_normal_clearing,
failed_convert_to_tiff_issue,
failed_fs_2,
failed_fs_3,
failed_fs_8,
failed_fs_9,
failed_fs_31,
failed_fs_32,
failed_fs_35,
failed_fs_39,
failed_fs_48,
failed_fs_49
from_number
string

Filter by source/from fax number in E.164 format

Required string length: 2 - 16
Pattern: ^[+][1-9][0-9]{1,14}$
to_number
string

Filter by destination/to fax number in E.164 format

Required string length: 2 - 16
Pattern: ^[+][1-9][0-9]{1,14}$
is_read
boolean

Filter by read status. true for read faxes, false for unread faxes

min_pages
integer

Filter faxes with at least this many pages

Required range: 0 <= x <= 9999
max_pages
integer

Filter faxes with at most this many pages

Required range: 0 <= x <= 9999

Response

Response containing a list of faxes

List of fax data

data
object