Skip to main content
GET
/
cases
/
{case_id}
/
faxes
List faxes
curl --request GET \
  --url https://api.example.com/v1/cases/{case_id}/faxes \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "01K8FX08HJ7T44HRYE78AN7HHH",
      "institution_contact_id": "<string>",
      "to_number": "+11112223333",
      "from_number": "+11112223333",
      "status": "delivered",
      "pages": 3,
      "document_ids": [
        "<string>"
      ],
      "cover_page": true,
      "cover_page_note": "Re: Estate of John J. Johnson. Please process enclosed death certificate and account closure form.",
      "sent_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z",
      "failed_reason": null,
      "receipt": {
        "confirmation_number": "FAX-2025-1015-001",
        "pages_sent": 3,
        "duration_seconds": 45,
        "status": "confirmed",
        "remote_station_id": "<string>",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "sent_by": "<string>",
      "notes": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

case_id
string
required

Unique case identifier (ULID format).

Query Parameters

page
integer
default:1

Page number for pagination.

Required range: x >= 1
per_page
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
status
enum<string>
Available options:
queued,
sending,
delivered,
failed,
cancelled
institution_contact_id
string

Response

List of faxes.

data
object[]
meta
object