latestOpenAPI 3.0.02026-08-232861531.0 MB
d3c75c2a2f1d
engagements
List engagements
get/engagements
Query parameters
recipientstring
ID of the recipient user.
recipientType'doctor' | 'staff' | 'patient' | 'system'
status'in-progress' | 'failed' | 'success' | 'escalation_required' | 'idle'
userstring
The ID of the root account user.
deleted0 | 1
Flag for logical deletion where 1 means deleted.
createdBystring
The ID of the user who created this object.
updatedBystring
The ID of the user who updated this object.
createdAtstring date-time
The date/time when this object was created.
updatedAtstring date-time
The date/time when this object was updated.
pageinteger
limitinteger
How many items to fetch per page
_populatestring
Response properties which will be replaced by the referenced objects, separated by commas.
_selectstring
Response properties that should be returned, separated by commas.
Response
List of engagements