Skip to main content
GET
/
comms
/
chat
/
get
Get Chat
curl --request GET \
  --url https://api.decodahealth.com/comms/chat/get \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "primaryPatientId": "<string>",
  "id": "<string>",
  "phoneNumber": "<string>",
  "patients": [],
  "optedOutOfSms": true,
  "messages": [],
  "emails": []
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
chat_id
string | null
​
patient_id
string | null

Response

Successful Response

​
primaryPatientId
string | null
required
​
id
string | null
​
phoneNumber
string | null
​
patients
ChatPatient · object[]
​
status
enum<string> | null
Available options:
READ,
UNREAD
​
optedOutOfSms
boolean | null
​
messages
(MessageSummary · object | CallSummary · object)[]
​
emails
ChatEmailSummary · object[]