Reminders

Get reminders with filtering and pagination

Changed on
get/Reminders

Request

Query parameters

PatientIdstring
ClientIdstring
IncludePatientsboolean

When filtering by string? GetRemindersQuery.ClientId, also include reminders for the client's patients (resolved through the primary-owner PatientContact rows), so a client view can roll up the whole household. Off by default: existing callers keep the exact-match behaviour (only reminders whose ClientId matches).

AppointmentIdstring
Categoryinteger
Statusinteger
IsActiveboolean
IsCompletedboolean
DueDateFromstring date-time
DueDateTostring date-time
SortBystring
SortOrderstring
integer
OR
string int32
integer
OR
string int32

Response

Paginated list of reminders

Changes