Get notified when a fax arrives
Subscribe to the fax.received webhook to be notified as soon as a fax lands in your inbox. Then use the endpoints below to get its details and download it.
Event | Fires when |
| A new fax is received |
| A fax is deleted |
See Webhooks API.
List faxes
GET /v1/faxes/inbox
Filter | Notes |
| Date-time range, e.g. |
| The fax number the fax was sent to |
| The sender's fax number |
|
|
| Fax line aliases |
| Organization locations |
|
|
| Include deleted faxes |
| Paging |
GET /v1/faxes/inbox?receivedOn.from=2026-11-10T00:00:00Z&pageSize=50
{
"Count": 1,
"Items": [
{
"Id": "UN05882b009c4ba908e9442f56276e4886",
"FaxId": "963524689",
"FaxLine": "2055550100",
"CallerId": "2055550199",
"Alias": "Intake",
"PageCount": 5,
"ReceivedOn": "2026-11-10T14:45:34+00:00",
"Location": { "Id": "OL3b309d00aceae09bd4544bef2658410e", "Name": "Main Office" },
"Tags": [],
"Archived": false
}
]
}
Get one fax: GET /v1/faxes/inbox/{id}
Download a fax
GET /v1/faxes/inbox/{id}/download
Returns the fax as a file (binary), not JSON.
GET https://{yourDomain}.nikohealth.com/api/external/v1/faxes/inbox/UN05882b009c4ba908e9442f56276e4886/download
Authorization: Bearer YOUR_ACCESS_TOKEN
Save the response body to a file, for example fax.pdf.
Delete faxes
One fax
DELETE /v1/faxes/inbox/{id}
Several faxes
POST /v1/faxes/inbox/trash
{ "faxIds": ["UN05882b009c4ba908e9442f56276e4886", "UN43944100153bc51b8444d45b07c841c0"] }
⚠️ This endpoint uses a camelCase field name (faxIds), unlike most NikoHealth requests.
Restore faxes
One fax
POST /v1/faxes/inbox/{id}/restore
Several faxes
POST /v1/faxes/inbox/restore
{ "faxIds": ["UN05882b009c4ba908e9442f56276e4886"] }
💡 To find deleted faxes to restore, list with includeArchived=true.
Filing a fax to a patient
The fax inbox API lets you read and manage faxes. To file a fax to a patient record:
Download the fax with
GET /v1/faxes/inbox/{id}/download.Upload it to the patient with
POST /v1/patients/{patientId}/documents.
If you don't know which patient a fax belongs to, upload it to Document Management instead (POST /v1/document-management/upload) so your team can identify and file it.
Common errors
Code | Meaning |
| Invalid request, e.g. a missing |
| Token missing, expired, or invalid |
| You don't have permission to access this resource |
| Fax not found |
| Too many requests |
