API Reference

Get Bookings [Alpha]

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

Overview

Get bookings of the authenticated client. Returns a paginated list of the client's appointments and event registrations.

Available for Client tokens only.

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

Maximum number of records which are returned for the request

string
required

First record's index in the returned list (e.g. per_page = 10, offset = 1, reords 11 to 20 are returned)

string
required

Business UID

string

Matter UID

string

If equals to true, returns records from the past only. Otherwise, returns future bookings as well.

string

Relevant to recurring appointment/event, returns appointment/event attendance which their start_time is bigger than this parameter

string

Relevant to recurring appointment/event, returns appointment/event attendance which their start_time is smaller than this parameter

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