---
title: "Get fax"
method: GET
path: "/faxes/{id}"
tags: ["Faxes"]
---

# Get fax

`GET /faxes/{id}`

Get fax information using the ID number of the fax.

## Path parameters

- `id` string, required — The id of a fax

## Response `200`

The fax

- Fax
  - `id` string — The id of a fax
  - `direction` 'OUTBOUND' | 'INBOUND' — The direction of the fax.
  - `from` string, phoneNumber — A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading '+'.
  - `to` string, phoneNumber — A phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format, including the leading '+'.
  - `contentUrl` string[] — Multiple URLs
  - `numberOfPages` integer — The number of pages in the fax.
  - `status` 'QUEUED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILURE' — The status of the fax
  - `price` Money — This is where we need description to be overridden by `$ref:` description
    - `currencyCode` string — The 3-letter currency code defined in ISO 4217.
    - `amount` string — The amount with 4 decimals and decimal delimiter `.`.
  - `barCodes` BarCode[] — The bar codes found in the fax. This field is populated when Sinch detects bar codes on incoming faxes.
    - `type` 'CODE_128' | 'DATA_MATRIX' — The type of barcode found.
    - `page` integer — The page number on which the barcode was found.
    - `value` string — The information of the barcode.
  - `createTime` string, date-time — A timestamp representing the time when the initial API call was made.
  - `completedTime` string, date-time — If the job is complete, this is a timestamp representing the time the job was completed.
  - `pagesSentSuccessfully` integer — The number of pages successfully sent to the receiving side in the fax.
  - `headerText` string — Text that will be displayed at the top of each page of the fax. 50 characters maximum. Default header text is "-". Note that the header is not applied until the fax is transmitted, so it will not appear on fax PDFs or thumbnails.
  - `headerPageNumbers` boolean — If true, page numbers will be displayed in the header. Default is true.
  - `headerTimeZone` string, timezone — A [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) string specifying the timezone for the header timestamp.
  - `retryDelaySeconds` integer — The number of seconds to wait between retries if the fax is not yet completed.
  - `labels` Labels — You can use this to attach labels to your call that you can use in your applications. It is a key value store. - `application/json` format: `"labels": {"label1":"value1"}` - `multipart/form-data` format: `labels[label1] = value1`
  - `callbackUrl` string, URL — The URL to which a callback will be sent when the fax is completed. The callback will be sent as a POST request with a JSON body. The callback will be sent to the URL specified in the `callbackUrl` parameter, if provided, otherwise it will be sent to the URL specified in the `callbackUrl` field of the Fax Service object. Note: If a callback URL uses basicauth credentials, when the callback URL is retrieved those credentials are masked. It is not possible to retrieve previously-set credentials through the API.
  - `callbackUrlContentType` 'multipart/form-data' | 'application/json' — The content type of the callback.
  - `imageConversionMethod` 'HALFTONE' | 'MONOCHROME' — Determines how documents are converted to black and white on OUTBOUND faxes only. Image conversion is not done on INBOUND faxes. Defaults to value selected on Fax Service object.
  - `errorType` 'DOCUMENT_CONVERSION_ERROR' | 'CALL_ERROR' | 'FAX_ERROR' | 'FATAL_ERROR' | 'GENERAL_ERROR' — Error type
  - `errorCode` integer — One of the error numbers listed in the [Fax Error Messages section](https://developers.sinch.com/docs/fax/api-reference/fax/error-messages).
  - `errorMessage` string — One of the error codes listed in the [Fax Error Messages section](https://developers.sinch.com/docs/fax/api-reference/fax/error-messages).
  - `maxRetries` integer — | The number of times the fax will be retired before cancel. Default value is set in your fax service. | The maximum number of retries is 5.
  - `retryCount` integer — The number of times the fax has been retried.
  - `hasFile` string — Only shown on the fax result. This indicates if the content of the fax is stored with Sinch. (true or false)
  - `resolution` 'FINE' | 'SUPERFINE' — The resolution for the fax. If this is set at the service, this applies to all faxes sent using that service. If this is set on the fax, this will override the service setting.
  - `coverPageId` string — The cover page id you want to use for the fax
  - `coverPageData` CoverPageData — You can use this to specify custom data for your cover page that will be sent as part of the fax. It is a key value store. Read more about how to use this [here](https://developers.sinch.com/docs/fax/api-reference/fax/cover-pages/). All keys used must be lower case. - `application/json` format: `"coverPageData": {"customfield1":"customdata1"}` - `multipart/form-data` format: `coverPageData[customfield1] = customdata1`
  - `inProgressNotifications` boolean — If set to `true`, you will receive a webhook notification for each page sent on an outbound fax.
  - `projectId` string — The `Id` of the project associated with the call.
  - `serviceId` string — ID of the fax service used.

---

[API](https://skmtc.net/sinch/apis/fax-api.md) · [All operations](https://skmtc.net/sinch/apis/fax-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/fax-api/revisions/ebcbb377ee0f/schema)