Skip to main content
GET
Get Fax

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

fax_id
string
required

Response

Successful Response

id
string
required
direction
enum<string>
required

Direction of a fax. INBOUND is defined now so inbound work later just adds rows.

Available options:
OUTBOUND,
INBOUND
status
enum<string>
required

Lifecycle status of a fax. Values mirror SignalWire's LaML fax status values.

Available options:
QUEUED,
SENDING,
DELIVERED,
FAILED,
CANCELED,
NO_ANSWER,
BUSY
signalwireFaxSid
string | null
required
phoneNumberId
string | null
required
phoneNumberE164
string | null
required
faxContact
FaxContactResponse · object | null
required
numPages
integer | null
required
cost
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
errorCode
string | null
required
errorMessage
string | null
required
pdfPath
string | null
required
sentAt
string<date-time> | null
required
completedAt
string<date-time> | null
required
createdByUserId
string | null
required
createdDate
string<date-time>
required
updatedDate
string<date-time> | null
required
patientId
string | null
patient
LinkedPatientRef · object | null

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.

filedDocument
LinkedDocumentRef · object | null

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.

readDate
string<date-time> | null
attachments
FaxAttachmentResponse · object[]
analysis
FaxAnalysisResponse · object | null

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.