Get fax list

Get a list of recent outbound faxes (which does not include batch faxes).

Arguments

Name	Type	Mandatory	Comments	Default
limit	Number		How many transactions to return.	25
lastId	String		Return results from this ID onwards (not including this ID). Used for pagination.	Infinite when sortOrder is desc; zero when sortOrder is asc.
sortOrder	String		asc or desc. Sorts by fax ID.	desc
userId	String		Enables a “primary” user to query for other account users’ faxes.	Current user (provided in credentials)

Response

If successful, an array of outbound fax structures at a detail level of “full” is returned:

Property	Description	Detail Level
		Result	Summary	Full
id	A unique identifier for the fax.
uri	A unique resource locator for the fax.
status	Fax status. Generally, 0= OK; less than 0 = in process; greater than 0 = Error (See Fax status codes)
userid	The submitting user.
pagesSent	Number of successfully sent pages.
completionTime	End time of last of all transmission attempts.
remoteCSID	Receiving party fax ID (up to 20 characters).
duration	Transmission time in seconds.
priority	For internal use.
units	Decimal number of units to be billed (pages or tenths of minutes)
costPerUnit	Monetary units, in account currency. Multiply this by ‘Units’ to get tde actual cost of the fax.
attemptsMade	Retry attempts actually performed.
pageSize	A4, Letter, Legal, or B4
pageOrientation	Portrait or Landscape
PageResolution	Standard or Fine
rendering	Standard (optimized for black & white) or Fine (optimized for grayscale)
pageHeader	The fax header text inserted at the top of the page.
submitTime	Time when the transaction was originally submitted. Always returned in GMT.
subject	A name or other optional identifier.
destinationFax	The resolved fax number to which the fax was sent.
replyEmail	E-mail address for confirmation message.
pagesSubmitted	Total number of pages submitted.
senderCSID	Sender’s fax ID.
attemptsToPerform	Maximum number of transmission attempts requested in case of fax transmission failure.
contact	The text which was inserted into the Contacts property upon submission of the fax (available in select submission methods only).

Sample calls

Raw HTTP

cURL

Get fax list

Get fax list. Limit to 10 results and order by asc

Sample response