---
title: "List faxes in the outbox"
method: GET
path: "/accounts/{user_id}/outbox"
tags: ["Outbox"]
---

# List faxes in the outbox

`GET /accounts/{user_id}/outbox`

Get a list of the faxes in the outbox which were not yet sent. (Permitted scopes: **fax:all:read**, **fax:fax:read**)

## Path parameters

- `user_id` string, required

## Response `200`

Response containing a list of faxes waiting to be sent

- OutboxList — List of the outgoing faxes
  - `records` Outbox[], required
    - `comment` OutboxComment — Comment to set for the fax job
      - `tags` string[]
      - `text` string
    - `contact_name` string
    - `designated_src` string
    - `extra_info` object
    - `file_changes` object[]
      - `at` string
      - `files` object[]
        - `file_name` string
        - `mime_type` string
        - `size` number
    - `files` string[] — Files to send
    - `id` string, required — Fax ID
    - `initiated_from` object
      - `from_id` string
      - `type` string
    - `ip` string — IP address from which the send request originated
    - `last_updated_status_time` string — Time and date when the send request status was last updated. Format: *YYYY-MM-DD HH:mm:ss*
    - `options` OutboxOptions — Additional configuration for sending a fax
      - `enhancement` boolean — Text enhancement. Set to True to optimize fax file for text.
      - `retry` RetryOptions — Fax retry settings
        - `count` integer — Number of tries to send the fax
        - `delay` integer — Delay in seconds between two retries
      - `partially_sent_retry` boolean — Enable automatic retry for partially sent faxes. Please make sure that the remote will accept chunked submissions before using it
    - `page_count` integer — Number of fax pages
    - `retry` RetryOptions — Fax retry settings
      - `count` integer — Number of tries to send the fax
      - `delay` integer — Delay in seconds between two retries
    - `send_time` string
    - `should_enhance` boolean
    - `src` string
    - `status` 'submitted' | 'converting' | 'scheduled_for_sending' | 'sending', required — Outbound fax status
    - `status_changes` object[]
      - `at` string, required — Date and time at which status changed. Format: *YYYY-MM-DD HH:mm:ss*
      - `status` 'submitted' | 'converting' | 'scheduled_for_sending' | 'sending', required — Outbound fax status
    - `submit_time` string — Date and time when the fax was submitted for sending
    - `to` string[]
    - `uid` string, required — User ID
    - `cover_page` OutboxCoverPage — 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 — Use company logo on the cover page

## Other responses

- `400` — Error object in case there's a problem with given data
- `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/revisions/c1afc85d2c15/schema)