Get batch child faxes

Retrieve information about a batch’s individual transactions.

GET /outbound/batches/{id}/children[?limit={number}&offset={number}]


Name (bold) if mandatory Type Comments Default
id Number The ID of the batch for which to retrieve data. None, mandatory.
limit Number How many transactions to return. 25
offset Number Skip this many transactions in the list. 0


If successful, an array of outbound fax structures, of detail level “summary” from the following list.

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 Interfax 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 A4LetterLegal, 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 Call


GET /outbound/batches/280101975/children?limit=10&offset=5 HTTP/0040: 1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=


Get batch child faxes. Return up to 10 results and skip 5 transactions each time

curl "" ^
	-u username:password