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

# Get a fax

> One fax. A fax that was removed (after 30 days, or on a request) answers 410, as its page on faxbeep.com does.



## OpenAPI

````yaml /openapi.json get /api/faxes/{slug}
openapi: 3.1.0
info:
  title: Faxbeep API
  version: 1.0.0
  description: >-
    Read-only JSON for the test faxes that faxbeep.com shows. No account and no
    token. Each fax is public for 30 days. The limits in this file (60 requests
    each minute, 100 faxes for each call, a default of 20, a default window of
    24 hours) are also variables in docs.json: change both.
servers:
  - url: https://faxbeep.com
security: []
tags:
  - name: Faxes
    description: Test faxes and scans, newest first.
paths:
  /api/faxes/{slug}:
    get:
      tags:
        - Faxes
      summary: Get a fax
      description: >-
        One fax. A fax that was removed (after 30 days, or on a request) answers
        410, as its page on faxbeep.com does.
      operationId: getFax
      parameters:
        - name: slug
          in: path
          required: true
          description: >-
            The slug of the fax, from the list or from the URL of its page on
            faxbeep.com: `fax_` and hexadecimal characters.
          schema:
            type: string
            pattern: ^fax_[a-f0-9]+$
          example: fax_5dd79a1c
      responses:
        '200':
          description: The fax.
          headers:
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fax'
              example:
                slug: fax_5dd79a1c
                source: phone
                from: +155*****123
                received_at: '2026-10-01T14:30:00Z'
                page_count: 3
                file_size: 245678
                pdf_url: https://cdn.faxbeep.com/faxes/fax_5dd79a1c.pdf
                thumbnail_url: https://cdn.faxbeep.com/faxes/fax_5dd79a1c-thumb.jpg
                view_url: https://faxbeep.com/faxtest/fax_5dd79a1c
        '404':
          description: >-
            No fax has this slug. A fax that is not in the list yet also answers
            404. A path under `/api/` that is not an endpoint answers 404 too.
          headers:
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: ''
        '410':
          description: >-
            The fax was removed: after 30 days, or on a request. The body does
            not say which.
          headers:
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: ''
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  headers:
    CacheControl:
      description: Always `no-store, private`. Do not cache an answer.
      schema:
        type: string
    XRateLimitLimit:
      description: 'Requests allowed each minute: 60.'
      schema:
        type: integer
    XRateLimitRemaining:
      description: Requests left in the current minute.
      schema:
        type: integer
  schemas:
    Fax:
      type: object
      description: A test fax or scan, as faxbeep.com shows it. The sender is masked.
      required:
        - slug
        - source
        - from
        - received_at
        - page_count
        - file_size
        - pdf_url
        - thumbnail_url
        - view_url
      properties:
        slug:
          type: string
          description: The ID of the fax. Use it with `GET /api/faxes/{slug}`.
          example: fax_5dd79a1c
        source:
          type: string
          enum:
            - phone
            - email
          description: >-
            `phone` for a fax by phone, `email` for a scan to email test or an
            Internet Fax test.
          example: phone
        from:
          type:
            - string
            - 'null'
          description: >-
            The sender, masked as on faxbeep.com: a number loses its middle 5
            digits, an address shows as `s***@e***.com`. A station ID with fewer
            than 6 digits shows as it is. `null` when the fax arrived with no
            sender ID (shown as Unknown on the site).
          example: +155*****123
        received_at:
          type: string
          format: date-time
          description: >-
            The time the fax arrived, in UTC with `Z`. This is the time that
            `since` compares. A fax appears in the API later, when its
            processing is done.
          example: '2026-10-01T14:30:00Z'
        page_count:
          type:
            - integer
            - 'null'
          description: The number of pages. `null` if the fax could not be processed.
          example: 3
        file_size:
          type:
            - integer
            - 'null'
          description: >-
            The size of the PDF, in bytes. `null` if the fax could not be
            processed.
          example: 245678
        pdf_url:
          type:
            - string
            - 'null'
          format: uri
          description: The PDF of the fax. `null` if the fax could not be processed.
          example: https://cdn.faxbeep.com/faxes/fax_5dd79a1c.pdf
        thumbnail_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            An image of the first page. `null` if the fax could not be
            processed.
          example: https://cdn.faxbeep.com/faxes/fax_5dd79a1c-thumb.jpg
        view_url:
          type: string
          format: uri
          description: The page of the fax on faxbeep.com.
          example: https://faxbeep.com/faxtest/fax_5dd79a1c
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          description: A short text. Empty for 404 and 410.
  responses:
    TooManyRequests:
      description: >-
        The rate limit is used up: 60 requests each minute for one IPv4 address
        or one IPv6 /64 block. Wait the number of seconds in `Retry-After`.
      headers:
        Retry-After:
          description: Seconds to wait before the next request.
          schema:
            type: integer
        X-RateLimit-Limit:
          $ref: '#/components/headers/XRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/XRateLimitRemaining'
        X-RateLimit-Reset:
          description: The time when requests are allowed again, as a Unix timestamp.
          schema:
            type: integer
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Too Many Attempts.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.