---
title: "View a fax"
method: GET
path: "/faxes/{id}"
tags: ["Programmable Fax Commands"]
---

# View a fax

`GET /faxes/{id}`

## Path parameters

- `id` string, uuid, required

## Response `200`

Get fax 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
    - `failure_reason` string, nullable — Customer-facing failure reason for the fax. Present on every fax object (null when the fax has not failed). Mapped from the more granular `internal_failure_reason`. Common values include: `receiver_call_dropped`, `sender_call_dropped`, `sender_canceled`, `carrier_lost`, `service_unavailable`, `fax_signaling_error`, `receiver_communication_error`, `sender_communication_error`, `receiver_decline`, `receiver_recovery_on_timer_expire`, `receiver_no_response`, `receiver_invalid_number_format`, `receiver_no_answer`, `receiver_incompatible_destination`, `receiver_unallocated_number`, `destination_unreachable`, `user_busy`, `invalid_ecm_response_from_receiver`, `fax_initial_communication_timeout`, `destination_not_in_service_plan`, `account_disabled`, `destination_invalid`, `no_outbound_profile`, `destination_not_in_countries_whitelist`, `user_channel_limit_exceeded`, `outbound_profile_channel_limit_exceeded`, `connection_channel_limit_exceeded`, `outbound_profile_daily_spend_limit_exceeded`, `unverified_origination_number`, `unverified_destination_not_allowed`, `file_format_invalid`, `file_download_failed`, `file_size_limit_exceeded`, `page_count_limit_exceeded`, `media_processing_exception`.
    - `internal_failure_reason` string, nullable — Internal, more granular failure reason for the fax. Present on every fax object (null when the fax has not failed). Useful for deeper debugging beyond the customer-facing `failure_reason`.

## Other responses

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

---

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