Skip to main content
GET
List Messages
This endpoint is currently under construction. Please reach out to support if you'd like to use it.
Returns all secure messages for your organization - both messages you have sent and messages received from other practitioners.
Note that some inbound messages might not be tied to any specific patient.
For real-time inbound notifications, use the message.received webhook rather than polling this endpoint.
This is a paginated endpoint. For more information see pagination.

Query Params

string
Filter messages by direction. One of outbound or inbound. If not provided, both directions are returned.
string
Filter messages to those related to a specific Patient.
string
Filter messages by exact destination.
string
Filter messages by status. One of processing, completed, or failed.

Response

object
required
Pagination metadata. See pagination.
An array of Message objects representing inbound and outbound messages.
Message[]
required

Rate Limits

See limits and throttling