AppointmentReminder
Get all appointment reminders
GET
Get all appointment reminders
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.
Query Parameters
The search query.
Maximum string length:
255The number of items per page.
Required range:
1 <= x <= 100The page number.
Required range:
x >= 1The field to sort by.
Available options:
scheduled_for, sent_at, created_at, updated_at The sort direction (asc or desc).
Available options:
asc, desc Filter by reminder type.
Available options:
appointment, cancellation_follow_up, session_confirmation, reschedule_confirmation Filter by send status.
Available options:
queued, sent, error Filter by approval status.
Available options:
pending, approved, rejected Filter by channel.
Maximum string length:
255Filter reminders whose appointment is scheduled from this date.
Filter reminders whose appointment is scheduled to this date.