Skip to main content
GET
List calendar events

Path Parameters

organisationId
string
required

The organisation ID

Example:

"org_31XEcUshz1ymodA14HALnyP48g1"

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

serviceDateMin
string<date-time>
serviceDateMax
string<date-time>
cancelledAtMin
string<date-time>
locationId
string[]
expand
enum<string>[]
Available options:
paymentMethod,
healthFundCard,
cancellationPolicy,
latestTransaction,
latestTransaction.transactionItems.billableItem,
location.business.capabilities,
providerLocationLink,
pmsAttendeeId,
location.registrations,
appointmentType.billableItems.serviceItem,
tags

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10