GET /faxes/{id}/file
Download a fax document
The fax itself, as raw bytes — usually a PDF. Not JSON: there is
no data envelope on success. Errors still come back as the usual JSON
error envelope.
| Scope | fax:read |
| Role permission | Fax History set to Allow with View Fax; Phone numbers |
| Cost | Free |
Content-Type is the document's type (application/pdf when unknown)
and Content-Disposition names it fax-{id}.pdf (or the matching
extension).
A sent fax's document can be missing until delivery finishes. The
final document is stored when the fax service reports the result, so
while a sent fax is pending this may answer 404 — retry once
GET /faxes/{id} shows success or failed.
A role with Fax History set to Allow (without View Fax) can list
faxes but gets 403 permission_denied here.
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
id | integer | yes | 7731455 | The fax id, from GET /faxes or a send. |
Responses
200
The document's bytes, with Content-Type set to its type (usually
application/pdf) and Content-Disposition: attachment; filename=fax-{id}.pdf.
Errors
| Status | Meaning |
|---|---|
400 | invalid_request — a missing or malformed field, an unknown enum value, or an unknown field in the body. Nothing was charged. |
401 | unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted. |
403 | Two different failures share this status, and the type tells them apart: |
404 | not_found — no such fax visible to the credential, or the fax has no document yet. For a sent fax still pending, retry after it completes. |
500 | internal_error — something failed on our side. For a send, nothing was charged, guaranteed, which is what makes a retry safe. |
See Errors for the full catalog and what to do about each.
Example
curl -X GET 'https://api.account.telebroad.com/api/public/v1/faxes/7731455/file' \
-H "Authorization: Bearer $TB_KEY"