List Appointments
Retrieve Appointments for a Location as JSON:API resource objects.
Pagination uses page and limit. The response includes the effective page, calculated offset, and limit in meta.pagination.
Date range values use YYYY-MM-DDTHH:MM:SS without a timezone. Provide filter[date_intersect_from] and filter[date_intersect_to] together; the end must be later than the start.
Related data can be requested by repeating the include parameter. Wire values remain literal API keys: client identifies Booking User data, staff identifies Team Member data, and goods identifies Products. Custom Field Value includes require the corresponding Business User permissions.
Path parameters
Location ID
Query parameters
Filter by Booking User profile ID
Filter by Event ID
Start of the Appointment intersection range, without a timezone
End of the Appointment intersection range, without a timezone
Page number
Maximum number of Appointments to return
Related resources to include; values are literal API keys
Headers
Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.
Bearer {partner_token}, User {user_token}
Response
Appointments retrieved successfully