curl --request GET \
--url https://api.decodahealth.com/faxes/{fax_id} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <api-key>'import requests
url = "https://api.decodahealth.com/faxes/{fax_id}"
headers = {
"TENANT": "<api-key>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<api-key>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/faxes/{fax_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/faxes/{fax_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/faxes/{fax_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<api-key>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/faxes/{fax_id}")
.header("TENANT", "<api-key>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/faxes/{fax_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<api-key>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"direction": "OUTBOUND",
"status": "QUEUED",
"signalwireFaxSid": "<string>",
"phoneNumberId": "<string>",
"phoneNumberE164": "<string>",
"faxContact": {
"id": "<string>",
"name": "<string>",
"faxNumber": "<string>",
"organization": "<string>",
"notes": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"createdByUserId": "<string>"
},
"numPages": 123,
"cost": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"pdfPath": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"patientId": "<string>",
"patient": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"filedDocument": {
"id": "<string>",
"title": "<string>",
"docType": "<string>"
},
"readDate": "2023-11-07T05:31:56Z",
"attachments": [
{
"id": "<string>",
"filename": "<string>",
"gcsPath": "<string>",
"sourceType": "PATIENT_CHART",
"displayOrder": 123,
"documentId": "<string>"
}
],
"analysis": {
"status": "PENDING",
"errorMessage": "<string>",
"extraction": {
"patientFirstName": "<string>",
"patientLastName": "<string>",
"patientDateOfBirth": "<string>",
"patientPhone": "<string>",
"patientMrn": "<string>",
"requestingProviderName": "<string>",
"documentCategory": "<string>",
"summary": "<string>",
"keySections": [
{
"heading": "<string>",
"content": "<string>"
}
],
"suggestedDocumentTitle": "<string>",
"suggestedDocType": "<string>",
"suggestedNoteTemplateId": "<string>"
},
"suggestedPatient": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"patientMatchConfidence": "HIGH",
"patientMatchReason": "<string>",
"suggestedTemplate": {
"id": "<string>",
"name": "<string>"
},
"suggestedProvider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"createdNoteId": "<string>",
"createdTaskId": "<string>",
"patientSuggestionDismissedAt": "2023-11-07T05:31:56Z",
"noteSuggestionDismissedAt": "2023-11-07T05:31:56Z",
"taskSuggestionDismissedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Get Fax
curl --request GET \
--url https://api.decodahealth.com/faxes/{fax_id} \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <api-key>'import requests
url = "https://api.decodahealth.com/faxes/{fax_id}"
headers = {
"TENANT": "<api-key>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<api-key>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/faxes/{fax_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/faxes/{fax_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/faxes/{fax_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<api-key>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/faxes/{fax_id}")
.header("TENANT", "<api-key>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/faxes/{fax_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<api-key>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"direction": "OUTBOUND",
"status": "QUEUED",
"signalwireFaxSid": "<string>",
"phoneNumberId": "<string>",
"phoneNumberE164": "<string>",
"faxContact": {
"id": "<string>",
"name": "<string>",
"faxNumber": "<string>",
"organization": "<string>",
"notes": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"createdByUserId": "<string>"
},
"numPages": 123,
"cost": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"pdfPath": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"patientId": "<string>",
"patient": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"filedDocument": {
"id": "<string>",
"title": "<string>",
"docType": "<string>"
},
"readDate": "2023-11-07T05:31:56Z",
"attachments": [
{
"id": "<string>",
"filename": "<string>",
"gcsPath": "<string>",
"sourceType": "PATIENT_CHART",
"displayOrder": 123,
"documentId": "<string>"
}
],
"analysis": {
"status": "PENDING",
"errorMessage": "<string>",
"extraction": {
"patientFirstName": "<string>",
"patientLastName": "<string>",
"patientDateOfBirth": "<string>",
"patientPhone": "<string>",
"patientMrn": "<string>",
"requestingProviderName": "<string>",
"documentCategory": "<string>",
"summary": "<string>",
"keySections": [
{
"heading": "<string>",
"content": "<string>"
}
],
"suggestedDocumentTitle": "<string>",
"suggestedDocType": "<string>",
"suggestedNoteTemplateId": "<string>"
},
"suggestedPatient": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"patientMatchConfidence": "HIGH",
"patientMatchReason": "<string>",
"suggestedTemplate": {
"id": "<string>",
"name": "<string>"
},
"suggestedProvider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"createdNoteId": "<string>",
"createdTaskId": "<string>",
"patientSuggestionDismissedAt": "2023-11-07T05:31:56Z",
"noteSuggestionDismissedAt": "2023-11-07T05:31:56Z",
"taskSuggestionDismissedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
The tenant you are making this request on behalf of
Your api key
Path Parameters
Response
Successful Response
Direction of a fax. INBOUND is defined now so inbound work later just adds rows.
OUTBOUND, INBOUND Lifecycle status of a fax. Values mirror SignalWire's LaML fax status values.
QUEUED, SENDING, DELIVERED, FAILED, CANCELED, NO_ANSWER, BUSY Show child attributes
Show child attributes
^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$Minimal patient reference for a fax linked to a chart (id + name only).
Lets the detail pane show "Linked to {name}" and the create-task dialog pre-fill the patient without a second fetch.
Show child attributes
Show child attributes
Minimal reference to the chart document a fax is filed to (id + current title + type). Lets the link dialog seed its fields with what's actually filed instead of opening blank, so re-confirming/relinking preserves them unless the user edits — no clobber from resent defaults.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The AI analysis surface on the fax detail: status + the three suggest-only cards (patient link / note / provider task).
extraction is the raw LLM output (summary, key sections, as-printed
identity, title/type hints); the suggested_* refs are the
deterministically matched rows staff can accept. *_dismissed_at
timestamps hide a card without deleting the underlying data.
Show child attributes
Show child attributes

