> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt
> Use this file to discover all available pages before exploring further.

# Get outgoing fax

> Get specific details of a fax currently scheduled for sending. (Permitted scopes: **fax:all:read**, **fax:fax:read**)

<RequestExample>
  ```js NodeJS SDK theme={null}
  const axios = require('axios');
  const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
  const Configuration = require('@alohi/faxplus-api').Configuration;

  const config = new Configuration({
      accessToken: accessToken,
      basePath: 'https://restapi.fax.plus/v3',
      // Header required only when using the OAuth2 token scheme
      baseOptions: {
          headers: {
            "x-fax-clientid": clientId,
          }
      }
  });

  async function getOutboxFax() {
      const reqParams = {
          "userId": '13d8z73c',
          "outboxFaxId": '132esd4cs31'
      }
      const req = await OutboxApiFp(config).getOutboxFax(reqParams);
      const resp = await req(axios);
  }

  getOutboxFax()
  ```

  ```python Python SDK theme={null}
  from faxplus import ApiClient, OutboxApi
  from faxplus.configuration import Configuration

  conf = Configuration()
  conf.access_token = access_token
  # header_name and header_value required only when using the OAuth2 token scheme
  api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
  api = OutboxApi(api_client)
  resp = api.get_outbox_fax(
      user_id='13d8z73c',
      outbox_fax_id='132esd4cs31')
  ```

  ```java Java theme={null}
  /**
   * Example below uses Apache HTTP Client 4 with Fluent API
   **/

  Map<String, String> pathParams = new HashMap<>();
  pathParams.put("user_id", "'13d8z73c'");
  pathParams.put("outbox_fax_id", "'132esd4cs31'");

  StrSubstitutor sub = new StrSubstitutor(values, "{", "}");
  String url = sub.replace("https://restapi.fax.plus/v3/accounts/{user_id}/outbox/{outbox_fax_id}");

  String result = Request
      .Get(url)
       // The x-fax-clientid header is required only when using the OAuth2 token scheme
      .addHeader("x-fax-clientid", "YOUR CLIENT_ID")
      .addHeader("Accept", "'application/json'")
      .addHeader("Authorization", "'Bearer {access-token}'")
      .execute()
      .returnContent().asString();

  System.out.println(result.toString());
  ```

  ```go Go theme={null}
  package main

  import (
         "bytes"
         "net/http"
  )

  func main() {

      headers := map[string][]string{
          // The x-fax-clientid header is required only when using the OAuth2 token scheme
          "Accept": []string{"application/json"},
          "Authorization": []string{"Bearer {access-token}"},
          "x-fax-clientid": []string{"YOUR CLIENT_ID"}
      }

      data := bytes.NewBuffer([]byte{jsonReq})
      req, err := http.NewRequest("GET", "https://restapi.fax.plus/v3/accounts/{user_id}/outbox/{outbox_fax_id}", data)
      req.Header = headers

      client := &http.Client{}
      resp, err := client.Do(req)
      // ...
  }
  ```

  ```php PHP theme={null}
  <?php

  require 'vendor/autoload.php';

  $headers = array(
      'Accept' => 'application/json',
      'Authorization' => 'Bearer {access-token}',
      // The x-fax-clientid header is required only when using the OAuth2 token scheme
      'x-fax-clientid' => '{client ID}',
  );

  $client = new GuzzleHttp\Client();

  try {
      $response = $client->request('GET','https://restapi.fax.plus/v3/accounts/{user_id}/outbox/{outbox_fax_id}', array(
          'headers' => $headers,
          )
      );
      print_r($response->getBody()->getContents());
   }
   catch (GuzzleHttp\Exception\BadResponseException $e) {
      // handle exception or api errors.
      print_r($e->getMessage());
   }

   // ...
  ```

  ```bash cURL theme={null}
  # You can also use wget
  curl -X GET https://restapi.fax.plus/v3/accounts/{user_id}/outbox/{outbox_fax_id} \
    -H 'Accept: application/json'  \
    -H 'Authorization: Bearer {access-token}' \
    # The x-fax-clientid header is required only when using the OAuth2 token scheme
    -H 'x-fax-clientid: "YOUR CLIENT_ID"'
  ```
</RequestExample>


## OpenAPI

````yaml get /accounts/{user_id}/outbox/{outbox_fax_id}
openapi: 3.0.1
info:
  title: Fax.Plus REST API
  description: >-
    This is the Fax.Plus API v3 developed for third party developers and
    organizations. In order to have a better coding experience with this API,
    let's quickly go through some points:<br /><br /> - This API assumes
    **/accounts** as an entry point with the base url of
    **https://restapi.fax.plus/v3**. <br /><br /> - This API treats all date and
    times sent to it in requests as **UTC**. Also, all dates and times returned
    in responses are in **UTC**<br /><br /> - Once you have an access_token, you
    can easily send a request to the resource server with the base url of
    **https://restapi.fax.plus/v3** to access your permitted resources. As an
    example to get the user's profile info you would send a request to
    **https://restapi.fax.plus/v3/accounts/self** when **Authorization** header
    is set to **Bearer YOUR_ACCESS_TOKEN** and custom header of
    **x-fax-clientid** is set to YOUR_CLIENT_ID
  version: 3.4.0
  contact:
    name: Fax.Plus
    email: info@fax.plus
    url: https://github.com/alohi
servers:
  - url: https://restapi.fax.plus/v3
  - url: /v3
security: []
paths:
  /accounts/{user_id}/outbox/{outbox_fax_id}:
    get:
      tags:
        - Outbox
      summary: Get outgoing fax
      description: >-
        Get specific details of a fax currently scheduled for sending.
        (Permitted scopes: **fax:all:read**, **fax:fax:read**)
      operationId: getOutboxFax
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            default: self
          description: >-
            User ID. Use 'self' for your own account, or provide a specific user
            ID for corporate member accounts.
          example: self
        - description: ID of the outgoing fax to get
          name: outbox_fax_id
          in: path
          required: true
          schema:
            type: string
          example: 132esd4cs31
      responses:
        '200':
          $ref: '#/components/responses/Outbox'
        '400':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - oauth2:
            - all
        - personal_access_token:
            - fax:all:read
            - fax:fax:read
components:
  responses:
    Outbox:
      x-go-name: OutboxResponse
      description: Response containing a single outbox object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Outbox'
    Error:
      description: Error object in case there's a problem with given data
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_user_id
            description: Invalid user id given
    ServerError:
      description: Error object in case there's a server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal_server_error
            description: An unexpected error happened, please contact support
  schemas:
    Outbox:
      description: Model for the outbound fax stored in the outbox
      type: object
      example:
        comment:
          tags: []
          text: ''
        contact_name: ''
        designated_src: ''
        extra_info: {}
        file_changes: []
        files:
          - /transient-29362c0c-eeff-45c1-9f4e-4ef5865a41df
        id: 13a4afb0585345639733857e8f36df8d
        initiated_from:
          from_id: ''
          type: ''
        ip: 8.8.8.8
        last_updated_status_time: '2017-09-24 06:43:04'
        options: {}
        page_count: 0
        retry:
          count: 0
          delay: 0
        send_time: 2017-09-24 06:43:04 +0000
        should_enhance: false
        src: '+16699990000'
        status: submitted
        status_changes:
          - at: '2017-09-24 06:43:04'
            status: submitted
        submit_time: 2017-09-24 06:43:04 +0000
        to:
          - '+16699990000'
        uid: 53a1afb8585345a39033857e1f36bf8d
      properties:
        comment:
          $ref: '#/components/schemas/OutboxComment'
        contact_name:
          type: string
        designated_src:
          type: string
        extra_info:
          type: object
        file_changes:
          items:
            properties:
              at:
                type: string
              files:
                items:
                  properties:
                    file_name:
                      type: string
                    mime_type:
                      type: string
                    size:
                      type: number
                type: array
          type: array
        files:
          description: Files to send
          items:
            type: string
          type: array
        id:
          description: Fax ID
          type: string
        initiated_from:
          properties:
            from_id:
              type: string
            type:
              type: string
          type: object
        ip:
          description: IP address from which the send request originated
          type: string
        last_updated_status_time:
          description: >-
            Time and date when the send request status was last updated. Format:
            *YYYY-MM-DD HH:mm:ss*
          pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}
          type: string
        options:
          $ref: '#/components/schemas/OutboxOptions'
        page_count:
          description: Number of fax pages
          minimum: 0
          type: integer
        retry:
          $ref: '#/components/schemas/RetryOptions'
        send_time:
          type: string
        should_enhance:
          type: boolean
        src:
          type: string
        status:
          $ref: '#/components/schemas/OutboxStatus'
        status_changes:
          items:
            properties:
              at:
                description: >-
                  Date and time at which status changed. Format: *YYYY-MM-DD
                  HH:mm:ss*
                pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}
                type: string
              status:
                $ref: '#/components/schemas/OutboxStatus'
            required:
              - at
              - status
          type: array
        submit_time:
          description: Date and time when the fax was submitted for sending
          type: string
        to:
          items:
            type: string
          type: array
        uid:
          description: User ID
          type: string
        cover_page:
          $ref: '#/components/schemas/OutboxCoverPage'
      required:
        - id
        - uid
        - status
      additionalProperties: false
    Error:
      properties:
        description:
          type: string
        error:
          type: string
      additionalProperties: false
    OutboxComment:
      properties:
        tags:
          default: []
          items:
            type: string
          type: array
        text:
          default: ''
          type: string
      description: Comment to set for the fax job
      type: object
    OutboxOptions:
      properties:
        enhancement:
          description: Text enhancement. Set to True to optimize fax file for text.
          default: true
          type: boolean
        retry:
          $ref: '#/components/schemas/RetryOptions'
        partially_sent_retry:
          type: boolean
          description: >-
            Enable automatic retry for partially sent faxes. Please make sure
            that the remote will accept chunked submissions before using it
      description: Additional configuration for sending a fax
      type: object
    RetryOptions:
      description: Fax retry settings
      example:
        retry:
          count: 2
          delay: 10
      properties:
        count:
          description: Number of tries to send the fax
          maximum: 3
          minimum: 0
          type: integer
        delay:
          description: Delay in seconds between two retries
          maximum: 180
          minimum: 0
          type: integer
      type: object
      additionalProperties: false
    OutboxStatus:
      description: Outbound fax status
      type: string
      enum:
        - submitted
        - converting
        - scheduled_for_sending
        - sending
    OutboxCoverPage:
      description: Fax cover page
      type: object
      required:
        - name_to
        - name_from
        - subject
      properties:
        name_to:
          type: string
          description: TO field on the cover page
        name_from:
          type: string
          description: FROM field on the cover page
        subject:
          type: string
          description: SUBJECT field on the cover page
        flags:
          type: array
          description: Cover page flags
          items:
            $ref: '#/components/schemas/CoverPageFlags'
        message:
          type: string
          description: MESSAGE field on the cover page
        include_company_logo:
          type: boolean
          description: Use company logo on the cover page
    CoverPageFlags:
      description: Allowed flags for the cover page
      type: string
      enum:
        - urgent
        - for_review
        - please_reply
        - confidential
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2 Authorization Grant
      flows:
        authorizationCode:
          authorizationUrl: >-
            https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
          tokenUrl: https://accounts.fax.plus/token
          refreshUrl: >-
            https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=YOUR_REFRESH_TOKEN
          scopes:
            all: >-
              for now when a user grants permission, all grants will be
              permitted
    personal_access_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Personal Access Token (PAT) is a Bearer token used for secure API calls.
        For direct API calls, the PAT is used in the Authorization header as
        'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client
        settings (e.g., in your IDE's MCP server configuration) - authentication
        will be handled automatically.

````