Appointments

List Attendance Appointments

Retrieve Appointments grouped under one attendance identifier as JSON:API resource objects.

Use record_{appointment_id} to retrieve the group containing one Appointment, or visit_{visit_id} to retrieve all Appointments linked to one visit. The attendance_id path parameter and both prefixes are literal wire values.

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.

get/locations/{location_id}/attendances/{attendance_id}/appointments

Path parameters

location_idinteger required

Location ID

attendance_idstring required
Example:record_12345

Attendance group identifier. Use the literal record_ prefix with an Appointment ID or the literal visit_ prefix with a visit ID.

Query parameters

includestring[]

Related resources to include; values are literal API keys

Headers

Acceptstring required

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Authorizationstring required

Bearer {partner_token}, User {user_token}

Response

Attendance Appointments retrieved successfully