faxes

Get fax status including latest provider attempt

get/api/v1/faxes/{id}

Request

  • Base URL: https://singlefax.com
  • URL: https://singlefax.com/api/v1/faxes/{id}
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.singlefax.com/api/auth/oauth2/authorize, token URL https://api.singlefax.com/api/auth/oauth2/token, scopes: fax:read)

Path parameters

idstring required

Response

Fax order

idstring required
idsstring[]

All order ids when sending to multiple destinations

recipientCountinteger
fulfillmentStatusstring required
paymentStatusstring required
subtotalCentsinteger
taxCentsinteger
totalCentsinteger
currencystring
billablePagesinteger
destinationCountrystring
destinationFaxNumberstring nullable
createdAtstring date-time
paymentChannelstring
providerStatusstring nullable
providerFaxIdstring nullable
failureReasonstring nullable
failureClassstring nullable
attemptCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.