inbox

Get a received fax

Non-HIPAA released rows include extracted fields and a bounded transcript slice (offset). HIPAA Secure transcripts stay on the website dashboard. Requires inbox:read.

get/api/v1/received-faxes/{id}

Request

  • Base URL: https://singlefax.com
  • URL: https://singlefax.com/api/v1/received-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: inbox:read)

Path parameters

idstring required

Query parameters

offsetinteger

Response

Received fax

idstring required
faxIdstring required
phoneNumberstring
fromPhonestring nullable
pageCountinteger
receivedAtstring date-time
releaseStatusstring
aiStatusstring nullable
summarystring
fieldsobject nullable
documentUrlstring uri nullable

Changes

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