Skip to Content
API access is available to organizations with a signed BAA. Request API access →
API referenceList conversations

List conversations

GET/me/conversations

Lists 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.

Scope
messages.read

Query parameters

afterstring

Only messages sent at or after this time. An RFC 3339 timestamp, or a date for midnight in the organization’s time zone.

beforestring

Only messages sent before this time. Same format as after.

patient_idUUID

Only conversations with this patient, on any phone number.

qstring

Words 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]integer

Number of records to return. Defaults to 50, maximum 100.

page[after]string

Cursor 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:

StatusCodeMeaning
400invalid_requestThe request is malformed, such as invalid JSON.
400invalid_queryThe q query can’t be parsed. See Search.
401invalid_tokenThe API key or access token is missing, expired, or revoked.
403insufficient_scopeThe credential doesn’t have the scope this endpoint needs.
403oauth_requiredAPI keys can’t use this endpoint. It needs an org admin’s OAuth token.
429rate_limitedToo many requests. Retry after Retry-After seconds.
Last updated on