Retrieve a list of all faxes

GET /v1/Faxes

TODO: Resource-level docs

Retrieve a list of all faxes.

Query parameters

  • From string

    Retrieve only those faxes sent from this phone number, specified in E.164 format.

  • To string

    Retrieve only those faxes sent to this phone number, specified in E.164 format.

  • DateCreatedOnOrBefore string(date-time)

    Retrieve only those faxes with a date_created that is before or equal to this value, specified in ISO 8601 format.

  • DateCreatedAfter string(date-time)

    Retrieve only those faxes with a date_created that is later than this value, specified in ISO 8601 format.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • OK

    Hide response attributes Show response attributes object
    • faxes array[object]
      Hide faxes attributes Show faxes attributes array[object]
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • api_version string | null

        The API version used to transmit the fax

      • date_created string(date-time) | null

        The ISO 8601 formatted date and time in GMT when the resource was created

      • date_updated string(date-time) | null

        The ISO 8601 formatted date and time in GMT when the resource was last updated

      • direction string | null

        The direction of the fax

        Values are inbound or outbound.

      • duration integer | null

        The time it took to transmit the fax

      • from string | null

        The number the fax was sent from

      • media_sid string | null

        The SID of the FaxMedia resource that is associated with the Fax

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ME[0-9a-fA-F]{32}$.

      • media_url string | null

        The Twilio-hosted URL that can be used to download fax media

      • num_pages integer | null

        The number of pages contained in the fax document

      • price number | null

        The fax transmission price

      • price_unit string(currency) | null

        The ISO 4217 currency used for billing

      • quality string | null

        The quality of the fax

        Values are standard, fine, or superfine.

      • sid string | null

        The unique string that identifies the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FX[0-9a-fA-F]{32}$.

      • status string | null

        The status of the fax

        Values are queued, processing, sending, delivered, receiving, received, no-answer, busy, failed, or canceled.

      • to string | null

        The phone number that received the fax

      • url string(uri) | null

        The absolute URL of the fax resource

    • meta object
      Hide meta attributes Show meta attributes object
GET /v1/Faxes
curl \
 -X GET https://fax.twilio.com/v1/Faxes \
 --user "username:password"
Response examples (200)
{
  "faxes": [
    {
      "account_sid": "string",
      "api_version": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "direction": "inbound",
      "duration": 42,
      "from": "string",
      "links": {},
      "media_sid": "string",
      "media_url": "string",
      "num_pages": 42,
      "price": 42.0,
      "price_unit": "string",
      "quality": "standard",
      "sid": "string",
      "status": "queued",
      "to": "string",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}
Response examples (200)
{
  "faxes": [
    {
      "account_sid": "string",
      "api_version": "string",
      "date_created": "2024-05-04T09:42:00+00:00",
      "date_updated": "2024-05-04T09:42:00+00:00",
      "direction": "inbound",
      "duration": 42,
      "from": "string",
      "links": {},
      "media_sid": "string",
      "media_url": "string",
      "num_pages": 42,
      "price": 42.0,
      "price_unit": "string",
      "quality": "standard",
      "sid": "string",
      "status": "queued",
      "to": "string",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}