reminders
List reminders
get/reminders
Request
- Base URLhttps://api.lumahealth.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
providerstring
appointmentstring
referralstring
recallstring
telehealthstring
followupstring
followupOperation'created' | 'deleted' | 'updated'
facilitystring
patientstring
patientFormstring
messagestring
type'appointment' | 'feedback' | 'referral' | 'outbound-referral' | 'followup' | 'patient-form' | 'recall' | 'telehealth' | 'waiting-room'
sendAtstring date-time
sentAtstring date-time
messageTemplatestring
status'scheduled' | 'pending' | 'queued' | 'sent' | 'confirmed' | 'emailOpened' | 'skipped' | 'delivered' | 'blocked'
statusReasonstring
repliedinteger
repliedMessagestring
originalRepliedMessagestring
repliedTimestring date-time
forcedTimeboolean
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 reminders
Changes
No recorded changes to this operation across all 6 revisions of this API.