Skip to main content
GET
Get all appointments

Authorizations

Authorization
string
header
required

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

FlowAuthorization Code
Authorization URL
https://dev.flextell.ai/oauth/authorize
Token URL
https://dev.flextell.ai/oauth/token

Headers

X-Tenant
number
required

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

Query Parameters

search
string | null

The search query.

Maximum string length: 255
per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
page
integer | null

The page number.

Required range: x >= 1
sort_by
enum<string> | null

The field to sort by.

Available options:
scheduled_at,
status,
created_at,
updated_at
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
status
enum<string> | null

Filter by appointment status.

Available options:
pending,
approved,
cancelled,
rejected,
completed,
no_show
relation_type
enum<string> | null

Filter by appointment relation type.

Available options:
parent,
child
customer_id
integer | null

Filter by customer.

user_id
integer | null

Filter by assigned user.

parent_appointment_id
integer | null

Filter by parent appointment.

from
string<date-time> | null

Filter appointments from this date.

to
string<date-time> | null

Filter appointments to this date.

trashed
boolean | null

Filter by trashed status.

Response

Paginated set of AppointmentResource

data
AppointmentResource · object[]
required
meta
object
required