List conversations
/me/conversationsLists the connected person’s own conversations, team chats and patient conversations alike, with messages in a time range, most recently active first, each with its latest message and how many messages fell in the range.
Query parameters
afterstringOnly messages sent at or after this time. An RFC 3339 timestamp, or a date for midnight in the organization’s time zone.
beforestringOnly messages sent before this time. Same format as after.
patient_idUUIDOnly conversations with this patient, on any phone number.
qstringWords and operators to filter conversations by, like is:unread doe. Free text matches conversation titles and participant names. Also supports is:unread and with: a user or patient ID. See Search.
page[limit]integerNumber of records to return. Defaults to 50, maximum 100.
page[after]stringCursor from the previous page’s pagination.next_cursor.
Returns
Returns 200 OK with a data array of Conversation objects and a pagination object. See pagination.
Errors
Failed requests return application/problem+json problem details. The errors specific to this endpoint:
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | The request is malformed, such as invalid JSON. |
| 400 | invalid_query | The q query can’t be parsed. See Search. |
| 401 | invalid_token | The API key or access token is missing, expired, or revoked. |
| 403 | insufficient_scope | The credential doesn’t have the scope this endpoint needs. |
| 403 | oauth_required | API keys can’t use this endpoint. It needs an org admin’s OAuth token. |
| 429 | rate_limited | Too many requests. Retry after Retry-After seconds. |