Get a received fax
curl --request GET \
--url https://api.healos.ai/ext-api/v1/faxes/{faxId} \
--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/{faxId}', 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/{faxId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "f0000000-0000-4000-8000-000000000001",
"received_at": "2026-11-05T15:00:00.000Z",
"source": "ifax",
"from_number": "+15555550123",
"filename": "<string>",
"file_type": "pdf",
"pages": 123,
"document_type": "prescription",
"is_urgent": true,
"processing_status": "completed",
"patient_id": "<string>",
"ehr_filing": {
"status": "synced",
"ehr": "modmed",
"ehr_patient_id": "<string>",
"ehr_document_id": "<string>",
"filed_at": "2026-11-05T15:04:05.000Z"
},
"extracted_fields": {}
}
}{
"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 received fax
One received fax with the fields HealOS extracted from it. Another organization’s fax is a 404. Requires the fax:read scope.
GET
/
faxes
/
{faxId}
Get a received fax
curl --request GET \
--url https://api.healos.ai/ext-api/v1/faxes/{faxId} \
--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/{faxId}', 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/{faxId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "f0000000-0000-4000-8000-000000000001",
"received_at": "2026-11-05T15:00:00.000Z",
"source": "ifax",
"from_number": "+15555550123",
"filename": "<string>",
"file_type": "pdf",
"pages": 123,
"document_type": "prescription",
"is_urgent": true,
"processing_status": "completed",
"patient_id": "<string>",
"ehr_filing": {
"status": "synced",
"ehr": "modmed",
"ehr_patient_id": "<string>",
"ehr_document_id": "<string>",
"filed_at": "2026-11-05T15:04:05.000Z"
},
"extracted_fields": {}
}
}{
"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?

