Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Practice Management

Retrieve an existing message in doctor's message center

get/api/messages/{id}

Path parameters

idstring required

Query parameters

patientinteger
doctorinteger
responsible_userinteger
updated_sincestring
received_sincestring
ownerinteger
typestring

Response

OK

type_descriptionstring

Type Description

patient_middle_namestring

Patient Middle Name

updated_atstring
ownerstring

ID of /api/users who owns the message, who may be the doctor themselves or one of their staff members

responsible_user_first_namestring

Responsible User First Name

received_atstring
idinteger
doctor_last_namestring

Doctor Last Name

owner_first_namestring

Owner First Name

archivedboolean

If true, indicates that the message has been soft-deleted

doctorinteger required
owner_last_namestring

Owner Last Name

patient_first_namestring

Patient First Name

attachmentstring

Files are passed using multipart/form-data encoding, but returned as URLs.

outgoing_fax_recipient_fax_numberstring

Outgoing fax recipient fax number

responsible_user_last_namestring

Responsible User Last Name

type'GP' | 'GC' | 'GT' | 'GZ' | 'IF' | 'OF' | 'IL' | 'IR' | 'OR' | 'IE' | 'CE' | 'CH' | 'OA' | 'PO' | 'PI' | 'PM' | 'OO' | 'OD' | 'ID' | 'DL' | 'CN'
ValueDescription
"GP"Generated PDF
"GC"Generated CSV
"GZ"Generated ZIP
"IF"Incoming Fax
"OF"Outgoing Fax
"IL"Incoming Labs
"IR"Inbound Referrals
"OR"Outbound Referrals
"IE"Incoming eRx
"OA"Online Appointments
"PO"Patient Onboarding
"PI"Patient Incoming Message
"PM"Patient Outgoing Message
"OO"Demo Meeting Message
"OD"Outbound Direct Message
"ID"Inbound Direct Message
patient_last_namestring

Patient Last Name

patientinteger

ID of patient that the message concerns, if applicable

doctor_first_namestring

Doctor First Name

readboolean
responsible_userstring

ID of /api/users who has been assigned to process the message, who may be the doctor themselves or one of their staff members

workflow_stepstring

Used by doctors and their staff to keep track of what step of processing the message is in

outgoing_fax_recipient_namestring

Outgoing fax recipient name

doctor_middle_namestring

Doctor Middle Name

titlestring required
starredboolean