Skip to main content
GET
Get all appointment reminders

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

search
string | null

The search query.

Maximum string length: 255
per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by. appointment_date sorts by the related appointment's scheduled date.

Mevcut seçenekler:
scheduled_for,
sent_at,
created_at,
updated_at,
appointment_date,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null
type
enum<string> | null

Filter by reminder type.

Mevcut seçenekler:
appointment,
cancellation_follow_up,
session_confirmation,
reschedule_confirmation,
null
status
enum<string> | null

Filter by send status.

Mevcut seçenekler:
queued,
sent,
error,
expired,
null
approval_status
enum<string> | null

Filter by approval status.

Mevcut seçenekler:
pending,
approved,
rejected,
null
channel
string | null

Filter by channel.

Maximum string length: 255
from
string<date-time> | null

Filter reminders whose appointment is scheduled from this date.

to
string<date-time> | null

Filter reminders whose appointment is scheduled to this date.

Yanıt

Paginated set of AppointmentReminderResource

data
AppointmentReminderResource · object[]
gerekli
meta
object
gerekli