Skip to content

List Attendance Appointments

Request

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.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

attendance_idstring^(record|visit)_[0-9]+$required

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

Example:record_12345
Query
includeArray of strings, unique(Appointment Includes)

Related resources to include; values are literal API keys

Items Enum:"client""client.custom_field_values""staff""services""goods""resource_instances""labels""attendance_service_items""attendance_good_items""attendance_document"
Headers
Acceptstringrequired

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

Default:"application/vnd.api.v2+json"
Example:application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/attendances/record_12345/appointments?include=client' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Attendance Appointments retrieved successfully

Bodyapplication/json
dataArray of objects(Appointment Resource)required
includedArray of objects(includedResource)

Resources requested through include, when available

Response
{
  "data": [
    { … }
  ],
  "included": [
    { … }
  ]
}