API Reference

Get Appointments List

get
https://api.vcita.biz/platform/v1/scheduling/appointments

Overview

Retrieves a paginated list of appointments for the business. Supports filtering by client, appointment state, and sorting. Available for Staff and Application tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Business ID (optional)

string

Client ID Filter

string

State Filter - rejected/scheduled/done/cancelled/pending_reschedule/reschedule e.g state=done,rejected

string

Multiple order by option - updated:DESC,start_at:ASC,created:DESC

integer

Page number of results. Default: 1

integer

How many items to return per page. Default: 25. Max: 100

Response

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago