Skip to main content
GET
Get all appointments

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. Defaults to scheduled_at. upcoming lists upcoming appointments nearest first, then past ones most recent first; it ignores sort_order and takes precedence over search relevance.

Mevcut seçenekler:
scheduled_at,
status,
created_at,
updated_at,
upcoming,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

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

Filter by appointment status.

Mevcut seçenekler:
pending,
approved,
cancelled,
rejected,
completed,
no_show,
null
relation_type
enum<string> | null

Filter by appointment relation type.

Mevcut seçenekler:
parent,
child,
null
customer_id
integer | null

Filter by customer.

lead_id
integer | null

Filter by a visible lead.

user_id
integer | null

Filter by assigned user.

parent_appointment_id
integer | null

Filter by parent appointment.

tags[]
integer[]

A tag ID to filter by.

assistant_id
integer | null

Filter by assigned assistant.

treatments[]
integer[]

A treatment ID to filter by.

room_id
integer | null

Filter by room.

session_type
enum<string> | null

Filter by session type.

Mevcut seçenekler:
control,
operation,
treatment,
consultation,
follow_up,
emergency,
surgery,
null
is_ai_generated
boolean | null

Filter by whether the appointment was generated by the AI assistant.

has_sale
boolean | null

Filter by whether the appointment has an associated sale.

is_control_appointment
boolean | null

Filter by whether the appointment is a control appointment.

scheduled_at_from
string<date-time> | null

Filter appointments scheduled from this date (inclusive).

scheduled_at_to
string<date-time> | null

Filter appointments scheduled up to this date (inclusive end-of-day).

created_at_from
string<date-time> | null

Filter appointments created from this date (inclusive).

created_at_to
string<date-time> | null

Filter appointments created up to this date (inclusive end-of-day).

Yanıt

Paginated set of AppointmentResource

data
AppointmentResource · object[]
gerekli
meta
object
gerekli