List Appointments

Request

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.

Security

BearerPartnerUser

Path

location_idintegerrequired

Location ID

Query

filter[client_id]integer, >= 1

Filter by Booking User profile ID

filter[activity_id]integer, >= 1

Filter by Event ID

filter[date_intersect_from]string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Start of the Appointment intersection range, without a timezone

Example:filter[date_intersect_from]=2026-01-01T00:00:00

filter[date_intersect_to]string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

End of the Appointment intersection range, without a timezone

Example:filter[date_intersect_to]=2026-01-31T23:59:59

pageinteger, >= 1

Page number

Default:1

limitinteger, [ 1 .. 250 ]

Maximum number of Appointments to return

Default:250

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"

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}/appointments?filter%5Bclient_id%5D=1&filter%5Bactivity_id%5D=1&filter%5Bdate_intersect_from%5D=2026-01-01T00%3A00%3A00&filter%5Bdate_intersect_to%5D=2026-01-31T23%3A59%3A59&page=1&limit=250&include=client' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Appointments retrieved successfully

Bodyapplication/json

dataArray of objects(Appointment Resource)required

metaobjectrequired

includedArray of objects(includedResource)

Resources requested through include, when available

Response

{
  "data": [
    { … }
  ],
  "meta": {
    "pagination": { … }
  }
}