---
title: "List faxes"
method: GET
path: "/cases/{case_id}/faxes"
tags: ["Faxes"]
---

# List faxes

`GET /cases/{case_id}/faxes`

## Request

- Base URL: `https://api.example.com/v1`
- URL: `https://api.example.com/v1/cases/{case_id}/faxes`
- Auth: none declared

List all faxes sent for a case, including delivery receipts.

## Query parameters

- `page` integer
- `per_page` integer
- `status` 'queued' | 'sending' | 'delivered' | 'failed' | 'cancelled'
- `institution_contact_id` string

## Response `200`

List of faxes.

- object
  - `data` Fax[]
    - `id` string
    - `institution_contact_id` string, nullable: Reference to the institution contact faxed.
    - `to_number` string
    - `from_number` string: Sunset-managed fax number.
    - `status` 'queued' | 'sending' | 'delivered' | 'failed' | 'cancelled'
    - `pages` integer
    - `document_ids` string[]: Case document IDs that were faxed.
    - `cover_page` boolean: Whether a cover page was included.
    - `cover_page_note` string, nullable
    - `sent_at` string, date-time, nullable
    - `delivered_at` string, date-time, nullable
    - `failed_reason` string, nullable
    - `receipt` object, nullable: Fax delivery receipt.
      - `confirmation_number` string
      - `pages_sent` integer
      - `duration_seconds` integer
      - `status` 'confirmed' | 'partial' | 'failed'
      - `remote_station_id` string, nullable: The receiving fax machine's station ID.
      - `timestamp` string, date-time
    - `sent_by` string, nullable: User ID of the person who sent the fax.
    - `notes` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `meta` PaginationMeta
    - `page` integer
    - `per_page` integer
    - `total_count` integer
    - `total_pages` integer
    - `next_cursor` string, nullable: Opaque cursor for fetching the next page. Pass as the `cursor` query parameter. Null when on the last page.
    - `has_more` boolean: Whether more results exist beyond this page.

## Other responses

- `404`: Resource not found.

---

[API](https://skmtc.dev/hellosunset/apis/sunset-api.md) - [All operations](https://skmtc.dev/hellosunset/apis/sunset-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hellosunset/apis/sunset-api/revisions/f128e5526efe?raw)