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

List patient conversations

GET/patient-conversations

Lists patient conversations with messages in a time range, most recently active first, each with its latest message and how many messages fell in the range. Filter to one patient with patient_id. Every request passes after or patient_id, so a read is always bounded; there’s no search by patient name.

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.

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.
400range_requiredPass after or patient_id, so every read is bounded.
401invalid_tokenThe API key or access token is missing, expired, or revoked.
403insufficient_scopeThe credential doesn’t have the scope this endpoint needs.
429rate_limitedToo many requests. Retry after Retry-After seconds.
Last updated on