List all Faxes

The ability to read all of the faxes that are associated with your Account. This will be returned as a list of faxes.

Permissions

The API token must include the following scopes: Fax.

Path Parameters
AccountSid uuid — REQUIRED The Project ID that uniquely identifies the Account to retrieve.

Query Parameters
DateCreatedAfter string Filter the returned list of faxes to only those that were created after the specified date.
DateCreatedOnOrBefore string Filter the returned list of faxes to only those that were created on or before the specified date.
From string The phone number, in E.164 format, the fax was sent from.
To string The phone number, in E.164 format, the fax was sent to.

Responses

200 OK Schema — OPTIONAL meta object — OPTIONAL uri string — OPTIONAL first_page_uri string — OPTIONAL next_page_uri string — OPTIONAL previous_page_uri string — OPTIONAL page integer — OPTIONAL page_size integer — OPTIONAL key — OPTIONAL The name of the object faxes object[] — OPTIONAL account_sid string — OPTIONAL The unique identifier for the account this fax is associated with. api_version string — OPTIONAL The version of the SignalWire API. date_created string — OPTIONAL The date and time, in ISO 8601 format, the fax was created. date_updated string — OPTIONAL The date and time, in ISO 8601 format, the fax was updated. direction string — OPTIONAL Possible values: [inbound, outbound] The direction of the fax. Possible values are inbound or outbound. from string — OPTIONAL The phone number, in E.164 format, the fax was sent from. media_url string — OPTIONAL The URL hosting the received media. Can use this URL to download incoming media. Optionally pass a username and password using the format "https://user:pass@example.com/path/to/fax.pdf". media_sid string — OPTIONAL ThThe unique identifier for the media instance associated with the fax instance. num_pages string — OPTIONAL The number of pages in the fax document. price string — OPTIONAL The cost of the fax. price_unit string — OPTIONAL The currency, in ISO 4217 format, of the price. quality string — OPTIONAL Possible values: [standard, fine, superfine] The quality of the fax. sid string — OPTIONAL The unique identifier of the fax. status string — OPTIONAL Possible values: [queued, processing, sending, delivered, receiving, received, no-answer, busy, failed, canceled] The status of the fax. to string — OPTIONAL The phone number, in E.164 format, the fax was sent to. duration integer — OPTIONAL The time, in seconds, it took to deliver a fax. links object — OPTIONAL The URL links for resources associated with the fax. media string — OPTIONAL Media associated with this fax. url string — OPTIONAL The URL of this resource. error_code string — OPTIONAL Error code for this resource (if available). error_message string — OPTIONAL The description of this error (if available).