Skip to main content
GET
List appointments

Authorizations

api_access_token
string
header
required

All API requests must include the api_access_token header with a valid agent or administrator token.

Query Parameters

status
enum<string>
Available options:
pending,
confirmed,
completed,
cancelled,
rescheduled
provider_id
integer
service_id
integer
date
string<date>

Filter by specific date (YYYY-MM-DD)

start_date
string<date>

Range start date

end_date
string<date>

Range end date

Response

Appointments list

id
integer
contact_id
integer
service_id
integer
provider_id
integer
appointment_at
string<date-time>
status
enum<string>
Available options:
pending,
confirmed,
completed,
cancelled,
rescheduled
notes
string
cancellation_reason
string
conversation_id
integer
created_at
string<date-time>