Sign in
Faxes

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.

get/Accounts/{AccountSid}/Faxes

Path parameters

AccountSidstring uuid required

The Project ID that uniquely identifies the Account to retrieve.

Query parameters

DateCreatedAfterstring

Filter the returned list of faxes to only those that were created after the specified date.

Example:2018-11-26T20:00:00Z
DateCreatedOnOrBeforestring

Filter the returned list of faxes to only those that were created on or before the specified date.

Example:2017-06-26T20:00:00Z
Fromstring

The phone number, in E.164 format, the fax was sent from.

Example:+13103383454
Tostring

The phone number, in E.164 format, the fax was sent to.

Example:+13104456789

Response

OK

Example response

{
  "meta": {
    "key": "faxes"
  },
  "faxes": [
    {
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
      "api_version": "v1",
      "date_created": "2018-11-26T20:00:00Z",
      "date_updated": "2018-11-27T20:00:00Z",
      "direction": "outbound",
      "from": "+13103383454",
      "media_url": "https://example.com/fax.pdf",
      "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
      "num_pages": "null",
      "price": "null",
      "price_unit": "null",
      "quality": "standard",
      "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
      "status": "queued",
      "to": "+13104456789",
      "links": {
        "media": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
      },
      "url": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx",
      "error_code": "34004",
      "error_message": "The call dropped prematurely"
    }
  ]
}

Changes