Skip to main content
GET

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

Category parameter. Valid string values: inbox (received faxes), sent (outgoing faxes), or spam (spam faxes). Optional, defaults to 'inbox'.

Available options:
inbox,
sent,
spam
after
string

Start date to get records from that date. Format: YYYY-MM-DD HH:mm:ss (e.g., '2018-01-01 00:00:00'). Optional, if omitted returns all records from the beginning.

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

End date to get records before that date. Format: YYYY-MM-DD HH:mm:ss (e.g., '2020-01-01 00:00:00'). Optional, if omitted returns all records up to the current time.

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

Maximum number of fax records to return per request. Must be between 1 and 50. Optional, defaults to 50. Use with 'offset' for pagination.

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

Offset for pagination. Specifies the number of records to skip before starting to return records. Optional, defaults to 0.

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 list of valid fax statuses

Fax status. Some failure codes use failed_fs_* values which represent low-level fax transport issues (for example, fax protocol incompatibility, the remote endpoint stopping responding, or remote disconnections). In particular: failed_fs_8/failed_fs_9 indicate protocol incompatibility; failed_fs_31/failed_fs_32 indicate that the remote stopped responding; failed_fs_35/failed_fs_39 indicate that the remote disconnected.

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_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