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.

outbox_fax_id
string
required

ID of the outgoing fax to get

Response

Response containing a single outbox object

Model for the outbound fax stored in the outbox

id
string
required

Fax ID

status
enum<string>
required

Outbound fax status

Available options:
submitted,
converting,
scheduled_for_sending,
sending
uid
string
required

User ID

comment
object

Comment to set for the fax job

contact_name
string
designated_src
string
extra_info
object
file_changes
object[]
files
string[]

Files to send

initiated_from
object
ip
string

IP address from which the send request originated

last_updated_status_time
string

Time and date when the send request status was last updated. Format: YYYY-MM-DD HH:mm:ss

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}
options
object

Additional configuration for sending a fax

page_count
integer

Number of fax pages

Required range: x >= 0
retry
object

Fax retry settings

Example:
send_time
string
should_enhance
boolean
src
string
status_changes
object[]
submit_time
string

Date and time when the fax was submitted for sending

to
string[]
cover_page
object

Fax cover page