---
title: "List fax logs"
method: GET
path: "/api/fax/logs"
tags: ["Fax Logs"]
---

# List fax logs

`GET /api/fax/logs`

List the available logs.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Fax_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

## Query parameters

- `include_deleted` boolean
- `created_before` string
- `created_on` string
- `created_after` string
- `page_size` integer
- `page_number` integer
- `page_token` string

## Response `200`

The request has succeeded.

- FaxLogListResponse
  - `links` FaxLogPaginationResponse, required
    - `self` string, required — URL for the current page of results.
    - `first` string, required — URL for the first page of results.
    - `next` string — URL for the next page of results. Only present when more results are available.
    - `prev` string — URL for the previous page of results. Only present when on page 1 or later.
  - `data` FaxFaxLog[], required — Array of log data
    - `id` string, uuid, required — Universal Unique Identifier.
    - `from` string, nullable, required — The origin phone number in E.164 format.
    - `to` string, nullable, required — The destination phone number in E.164 format.
    - `status` 'queued' | 'initiated' | 'ringing' | 'in-progress' | 'busy' | 'failed' | 'no-answer' | 'canceled' | 'completed', required — The status of this fax call.
    - `direction` 'inbound' | 'outbound-api' | 'outbound-dial', nullable, required — The direction of this fax call.
    - `source` 'laml', required — Source of this log entry.
    - `type` 'laml_call', required — Type of this log entry.
    - `url` string, uri, required — URL for the associated fax resource with this log entry.
    - `remote_station` string, nullable, required — Represents a customer hosted Fax server.
    - `charge` number, double, required — The amount charged for this fax request.
    - `number_of_pages` integer, nullable, required — The number of pages the fax document contained.
    - `quality` 'fine' | 'standard' | 'superfine', nullable, required — The quality that was set when the fax document was sent.
    - `charge_details` FaxChargeDetail[], required — Details on charges associated with this log.
      - `description` string, required — Description for this charge.
      - `charge` number, double, required — Charged amount.
    - `created_at` string, date-time, required — Date and time when the fax was created.
    - `error_code` string, nullable, required — Error code for this resource (if available).
    - `error_message` string, nullable, required — The description of this error (if available).

## Other responses

- `400` — The request is invalid.
- `401` — Access is unauthorized.
- `422` — The request contains invalid parameters. See errors for details.
- `500` — An internal server error occurred.

---

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