provider
comms

Get

Returns a list of Chats and the latest message in the chat, ordered by the latest message date by a patient or

Args: per_page (int, optional): Defaults to QueryParam(12). page (int, optional): Defaults to QueryParam(1). search_term (str, optional): a search param representing a patient name or phone number patient_id (str, optional): filter by specific patient ID query_param_chat_id (str, optional): prioritize specific chat ID in results unread_only (bool, optional): filter to only unread chats unresponded_only (bool, optional): filter to chats where last message was from patient location_id (str, optional): filter to patients at current user's location only human_only (bool, optional): filter to chats where latest message is from humans (not AI assistants)

get/comms/chat/list

Query parameters

pageinteger nullable
per_pageinteger nullable
sort_bystring nullable
sort_direction'asc' | 'desc' nullable
location_idstring nullable
search_termstring nullable
patient_idstring nullable
chat_idstring nullable
unread_onlyboolean
unresponded_onlyboolean
human_onlyboolean

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

totalinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.