---
title: "List fax records"
method: GET
path: "/accounts/{user_id}/faxes"
tags: ["Faxes"]
---

# List fax records

`GET /accounts/{user_id}/faxes`

Get your own or your subordinate's faxes list. (Permitted scopes: **fax:all:read**, **fax:fax:read**)

## Path parameters

- `user_id` string, required

## Query parameters

- `category` 'inbox' | 'sent' | 'spam'
- `after` string
- `before` string
- `limit` integer
- `offset` integer
- `sort_by` 'date' | 'from' | 'to' | 'comment' | 'pages'
- `order` 'asc' | 'desc'
- `in_progress` boolean
- `status` FaxStatus[]
- `from_number` string
- `to_number` string
- `is_read` boolean
- `min_pages` integer
- `max_pages` integer

## Response `200`

Response containing a list of faxes

- FaxList — List of fax data
  - `data` FaxListData
    - `records` Fax[]
      - `comment` string, required — Free-form comment
      - `cost` integer — Fax cost in the user currency
      - `cost_details` object, required
        - `multiplier` number
        - `notification_cost` number
      - `description` string
      - `direction` 'outgoing' | 'incoming' — Fax direction
      - `duration` integer — Fax transmission duration in seconds
      - `file` string — Fax file ID for the getFile handle
      - `file_name` string — Human-readable file name
      - `from` string — Sender number. Might be a userId for faxes sent or received with free accounts
      - `header` string
      - `id` string, required — Fax ID
      - `is_read` boolean
      - `is_spam` boolean — True if the fax is marked as spam
      - `last_update` string
      - `max_retry` integer — Maximum number of retries
      - `owner_id` string, required — User ID of the fax owner
      - `pages` integer, required — Number of pages in the fax
      - `retry_delay` integer — Delay between two retries
      - `scheduled_time` string
      - `start_time` string — Time at which faxing session started. Format: YYYY-MM-DD HH:mm:ss
      - `status` 'success' | 'partially_sent' | 'partially_received' | 'in_progress' | 'insufficient_credit' | 'failed' | 'failed_internal_process_error' | 'failed_user_busy' | 'failed_no_answer' | 'failed_unallocated_number' | 'failed_office_converter_issue' | 'failed_separate_file_pages_issue' | 'failed_render_header_issue' | 'failed_invalid_number_format' | 'failed_mimetype_not_supported' | 'failed_destination_not_supported' | 'failed_image_preparation' | 'failed_to_send' | 'failed_normal_temporary_failure' | 'failed_unknown_converter_issue' | 'failed_normal_clearing' | 'failed_convert_to_tiff_issue' | 'failed_fs_2' | 'failed_fs_3' | 'failed_fs_8' | 'failed_fs_9' | 'failed_fs_31' | 'failed_fs_32' | 'failed_fs_35' | 'failed_fs_39' | 'failed_fs_48' | 'failed_fs_49', required — Fax status. Some failure codes use failed_fs_* values which represent low-level fax transport issues (for example, fax protocol incompatibility, the remote endpoint stopping responding, or remote disconnections). In particular: failed_fs_8/failed_fs_9 indicate protocol incompatibility; failed_fs_31/failed_fs_32 indicate that the remote stopped responding; failed_fs_35/failed_fs_39 indicate that the remote disconnected.
      - `submit_time` string — Time when the fax was submitted for sending. For outgoing faxes only
      - `to` string — Fax destination number. Might be a userId for faxes sent or received with free accounts
      - `cover_page` FaxCoverPage — Fax cover page
        - `name_to` string, required — TO field on the cover page
        - `name_from` string, required — FROM field on the cover page
        - `subject` string, required — SUBJECT field on the cover page
        - `flags` CoverPageFlags[] — Cover page flags
        - `message` string — MESSAGE field on the cover page
        - `include_company_logo` boolean — Whether to include the company logo on the cover page

## Other responses

- `400` — Error object in case there's a problem with given data
- `401` — Error object in case there's a problem with the authorization
- `500` — Error object in case there's a server error

---

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