latestOpenAPI 3.1.1Altegio API Agreement2026-08-064243217.4 KB

bc9cbcc9c5f1

Events

List Events

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].

get/locations/{location_id}/events

Path parameters

location_idinteger required

Location ID

Query parameters

filter[from]string required
Example:2026-08-01 09:00:00

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

filter[to]string required
Example:2026-08-07 21:00:00

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

filter[master_ids][]integer[]

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

filter[service_ids][]integer[]

Service IDs

filter[capacity]integer

Minimum number of unoccupied places

pageinteger

Result page

limitinteger

Maximum number of Events to return

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

Events retrieved successfully