Messaging
Read one patient's visible conversations
Requires GP scope. Team keys stay in their own world. Returns conversations in storage order. Patient reads omit internal notes, assignments, queued/failed outgoing messages and automation configuration. The team key permits role-playing synthetic patients; this is not patient identity authentication. Templates remain available through the practice messaging-workspace operation.
get/api/sites/patient/messages
Request
- Base URLhttps://sim.animahealth.com
- Auth
- HTTP bearer
- or HTTP bearer
- or API key in cookie sim_session
Query parameters
patientIdstring required
Example:SIM-000003
Exact synthetic patient ID.
offsetinteger
Matching conversations to skip.
limitinteger
Maximum conversations in this page.
worldstring
Operator only: world to inspect or mutate. Team keys always use their own world.
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.