Skip to content

List Events

Request

Retrieve Events for a Location within a future date range. The response is a JSON:API collection with the literal resource type activity.

filter[from] must not be earlier than the current time, and filter[to] must be later than filter[from].

Security
BearerPartnerUser
Path
location_idinteger, >= 1required

Location ID

Query
filter[from]string^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}...required

Range start in the Location timezone as YYYY-MM-DD HH:MM:SS

Example:filter[from]=2026-08-01 09:00:00
filter[to]string^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}...required

Range end in the Location timezone as YYYY-MM-DD HH:MM:SS

Example:filter[to]=2026-08-07 21:00:00
filter[master_ids][]Array of integers, non-empty

Team Member IDs; the literal wire query key is filter[master_ids][]

filter[service_ids][]Array of integers, non-empty

Service IDs

filter[capacity]integer, >= 0

Minimum number of unoccupied places

pageinteger, >= 1

Result page

Default:1
limitinteger, [ 1 .. 250 ]

Maximum number of Events to return

Default:250
includeArray of strings, unique(Event Includes)

Related resources to include; values are literal API keys

Items Enum:"staff""service""resource_instances""labels""duration_details""master"
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}/events?filter%5Bfrom%5D=2026-08-01%2009%3A00%3A00&filter%5Bto%5D=2026-08-07%2021%3A00%3A00&filter%5Bmaster_ids%5D%5B%5D=1&filter%5Bservice_ids%5D%5B%5D=1&filter%5Bcapacity%5D=0&page=1&limit=250&include=staff' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Events retrieved successfully

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

Resources requested through include, when available

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