HEhellosunset
Faxes

List faxes

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

get/cases/{case_id}/faxes

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of items per page.

status'queued' | 'sending' | 'delivered' | 'failed' | 'cancelled'
institution_contact_idstring

Response

List of faxes.

Example response

{
  "data": [
    {
      "id": "01K8FX08HJ7T44HRYE78AN7HHH",
      "to_number": "+11112223333",
      "from_number": "+11112223333",
      "status": "delivered",
      "pages": 3,
      "cover_page": true,
      "cover_page_note": "Re: Estate of John J. Johnson. Please process enclosed death certificate and account closure form.",
      "receipt": {
        "confirmation_number": "FAX-2025-1015-001",
        "pages_sent": 3,
        "duration_seconds": 45,
        "status": "confirmed"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.