Skip to main content
GET
Download a received fax
Safety
  • Writes data: No
  • Safe to retry: Yes
  • Contacts an outside system: None
  • Dry run: Not needed (read-only).
The file is streamed through the API; there is no public URL to share or cache. With the CLI: healos fax download <faxId> --out fax.pdf (the file is created readable by you only). Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Path Parameters

faxId
string<uuid>
required

Fax identifier, from GET /faxes.

Example:

"f0000000-0000-4000-8000-000000000001"

Response

The file. Content-Disposition names it fax-<faxId>.<ext>.

The response is of type file.