Get a sent fax
curl --request GET \
--url https://api.healos.ai/ext-api/v1/faxes/outbound/{outboundFaxId} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/faxes/outbound/{outboundFaxId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/faxes/outbound/{outboundFaxId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "0f000000-0000-4000-8000-000000000001",
"created_at": "<string>",
"to_number": "+15555550199",
"to_name": "<string>",
"subject": "<string>",
"status": "queued",
"status_detail": "<string>",
"pages_sent": 123,
"total_pages": 123,
"fax_id": "<string>",
"retry_count": 123,
"delivered_at": "<string>",
"failed_at": "<string>",
"canceled_at": "<string>"
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}Fax
Get a sent fax
One sent fax and its stored delivery status. The status is what HealOS last recorded; this read never contacts the fax provider. Another organization’s fax is a 404. Requires the fax:read scope.
GET
/
faxes
/
outbound
/
{outboundFaxId}
Get a sent fax
curl --request GET \
--url https://api.healos.ai/ext-api/v1/faxes/outbound/{outboundFaxId} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/faxes/outbound/{outboundFaxId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/faxes/outbound/{outboundFaxId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "0f000000-0000-4000-8000-000000000001",
"created_at": "<string>",
"to_number": "+15555550199",
"to_name": "<string>",
"subject": "<string>",
"status": "queued",
"status_detail": "<string>",
"pages_sent": 123,
"total_pages": 123,
"fax_id": "<string>",
"retry_count": 123,
"delivered_at": "<string>",
"failed_at": "<string>",
"canceled_at": "<string>"
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}| Requirement | Detail |
|---|---|
| Scope | fax:read (rolling out: not yet on api.healos.ai) |
| Rate limit | About 60 requests per minute per API key (shared by all endpoints; approximate) |
| Cost | Free |
Safety
- Writes data: No
- Safe to retry: Yes
- Contacts an outside system: None
- Dry run: Not needed (read-only).
Was this page helpful?

