Faxes

List all Faxes

List all 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.

Query parameters

DateCreatedAfterstring

The date, in ISO 8601 format, after which the fax was sent.

DateCreatedOnOrBeforestring

The date, in ISO 8601 format, on or before which the fax was sent.

Fromstring

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

Tostring

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

Response

The request has succeeded.

uristring

The URI of the current page.

first_page_uristring

The URI of the first page.

next_page_uristring

The URI of the next page.

previous_page_uristring nullable

The URI of the previous page.

pageinteger

The current page number.

page_sizeinteger

The number of items per page.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
  "first_page_uri": "/api/laml/2010-04-01/Accounts?Page=0&PageSize=50",
  "next_page_uri": "/api/laml/2010-04-01/Accounts?Page=1&PageSize=50",
  "page_size": 50,
  "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",
      "from": "+13103383454",
      "media_url": "https://example.com/fax.pdf",
      "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
      "num_pages": "3",
      "price": "-0.005",
      "price_unit": "USD",
      "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
      "to": "+13104456789",
      "duration": 5000,
      "links": {
        "media": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
      },
      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx",
      "error_code": "34004",
      "error_message": "The call dropped prematurely"
    }
  ]
}