Skip to main content
GET
/
comms
/
chat
/
list
Get
curl --request GET \
  --url https://api.decodahealth.com/comms/chat/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "id": "<string>",
      "primaryPatientId": "<string>",
      "status": "READ",
      "patients": [
        {
          "id": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "primaryLocationId": "<string>"
        }
      ],
      "phoneNumber": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "optedOutOfSms": true,
      "latestMessageContent": "<string>",
      "latestMessageDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
page
integer | null
​
per_page
integer | null
​
sort_by
string | null
​
sort_direction
enum<string> | null
Available options:
asc,
desc
​
location_id
string | null
​
search_term
string | null
​
patient_id
string | null
​
chat_id
string | null
​
unread_only
boolean
default:false
​
unresponded_only
boolean
default:false
​
human_only
boolean
default:false

Response

Successful Response

​
data
ChatSummary · object[]
required
​
total
integer
required