---
title: "View a list of faxes"
method: GET
path: "/faxes"
tags: ["Programmable Fax Commands"]
---

# View a list of faxes

`GET /faxes`

## Query parameters

- `filter` object
  - `created_at` object — Date range filtering operations for fax creation timestamp
    - `gte` string, date-time — ISO 8601 date time for filtering faxes created after or on that date
    - `gt` string, date-time — ISO 8601 date time for filtering faxes created after that date
    - `lte` string, date-time — ISO 8601 formatted date time for filtering faxes created on or before that date
    - `lt` string, date-time — ISO 8601 formatted date time for filtering faxes created before that date
  - `direction` object — Direction filtering operations
    - `eq` string — The direction, inbound or outbound, for filtering faxes sent from this account
  - `from` object — From number filtering operations
    - `eq` string — The phone number, in E.164 format for filtering faxes sent from this number
  - `to` object — To number filtering operations
    - `eq` string — The phone number, in E.164 format for filtering faxes sent to this number
- `page[number]` integer
- `page[size]` integer

## Response `200`

List faxes response

- object
  - `data` Fax[]
    - `record_type` 'fax' — Identifies the type of the resource.
    - `id` string, uuid — Identifies the type of resource.
    - `connection_id` string — The ID of the connection used to send the fax.
    - `direction` 'inbound' | 'outbound' — The direction of the fax.
    - `media_url` string — The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be submitted together.
    - `media_name` string — The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. Supported formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and media_url/contents can't be submitted together.
    - `to` string — The phone number, in E.164 format, the fax will be sent to or SIP URI
    - `from` string — The phone number, in E.164 format, the fax will be sent from.
    - `from_display_name` string — The string used as the caller id name (SIP From Display Name) presented to the destination (`to` number).
    - `quality` 'normal' | 'high' | 'very_high' | 'ultra_light' | 'ultra_dark' — The quality of the fax. The `ultra` settings provides the highest quality available, but also present longer fax processing times. `ultra_light` is best suited for images, wihle `ultra_dark` is best suited for text.
    - `status` 'queued' | 'media.processed' | 'originated' | 'sending' | 'delivered' | 'failed' | 'initiated' | 'receiving' | 'media.processing' | 'received' — Status of the fax
    - `webhook_url` string — URL that will receive fax webhooks
    - `webhook_failover_url` string — Optional failover URL that will receive fax webhooks if webhook_url doesn't return a 2XX response
    - `store_media` boolean — Should fax media be stored on temporary URL. It does not support media_name.
    - `stored_media_url` string — If store_media was set to true, this is a link to temporary location. Link expires after 10 minutes.
    - `preview_url` string — If `store_preview` was set to `true`, this is a link to temporary location. Link expires after 10 minutes.
    - `client_state` string — State received from a command.
    - `created_at` string, date-time — ISO 8601 timestamp when resource was created
    - `updated_at` string, date-time — ISO 8601 timestamp when resource was updated
  - `meta` PaginationMeta
    - `total_pages` integer, required
    - `total_results` integer
    - `page_number` integer, required
    - `page_size` integer

## Other responses

- `404` — The requested resource does not exist
- `default` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/versions/e32d46c5945b/schema)