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.

fax_id
string
required

Response

Response containing a single fax object

comment
string
required

Free-form comment

cost_details
object
required
id
string
required

Fax ID

owner_id
string
required

User ID of the fax owner

pages
integer
required

Number of pages in the fax

Required range: x >= 0
status
enum<string>
required

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
cost
integer

Fax cost in the user currency

Required range: x >= 0
description
string
direction
enum<string>

Fax direction

Available options:
outgoing,
incoming
duration
integer

Fax transmission duration in seconds

Required range: x >= 0
file
string

Fax file ID for the getFile handle

file_name
string

Human-readable file name

from
string

Sender number. Might be a userId for faxes sent or received with free accounts

header
string
is_read
boolean
is_spam
boolean

True if the fax is marked as spam

last_update
string
max_retry
integer

Maximum number of retries

Required range: 0 <= x <= 3
retry_delay
integer

Delay between two retries

Required range: 0 <= x <= 180
scheduled_time
string
start_time
string

Time at which faxing session started. Format: YYYY-MM-DD HH:mm:ss

submit_time
string

Time when the fax was submitted for sending. For outgoing faxes only

to
string

Fax destination number. Might be a userId for faxes sent or received with free accounts

cover_page
object

Fax cover page