---
title: "List Events"
method: GET
path: "/locations/{location_id}/events"
tags: ["Events"]
---

# List Events

`GET /locations/{location_id}/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]`.

## Path parameters

- `location_id` integer, required

## Query parameters

- `filter[from]` string, required
- `filter[to]` string, required
- `filter[master_ids][]` integer[]
- `filter[service_ids][]` integer[]
- `filter[capacity]` integer
- `page` integer
- `limit` integer
- `include` string[]

## Headers

- `Accept` string, required
- `Authorization` string, required

## Response `200`

Events retrieved successfully

- EventCollectionResponse
  - `data` EventResource[], required
    - `type` 'activity', required — Literal JSON:API resource type returned for Events
    - `id` string, required — Event ID
    - `attributes` object, required
      - `master_id` integer, required — Deprecated wire field for Team Member ID; use `staff_id`
      - `staff_id` integer, required — Team Member ID
      - `service_id` integer, required — Service ID
      - `timestamp` integer, required — Event start as a Unix timestamp
      - `length` integer, required — Event duration in seconds
      - `capacity` integer, required — Total number of available places
      - `clients_count` integer, required — Number of Booking Users currently booked
      - `color` string, required — Event background color including `#`
      - `instructions` string, required — Instructions for Booking Users
      - `stream_link` string, required — Online Event stream link, or an empty string
      - `font_color` string, required — Event text color including `#`
      - `notified` boolean, required — Whether an Event notification was sent
      - `comment` string, nullable, required — Event comment
      - `schedule_id` integer, nullable, required — Event Schedule ID
      - `schedule_till` object, nullable, required — Event Schedule end represented by the production DateTime wire object
        - `date` string, required
        - `timezone_type` integer, required
        - `timezone` string, required
      - `schedule_event_modified` boolean, nullable, required — Whether this scheduled Event differs from its Event Schedule
      - `date` string, required — Event start in the Location timezone with a numeric offset
    - `relationships` object — Present when related data is requested through `include`
      - `staff` ToOneRelationship
        - `data` ResourceIdentifier, required
          - `type` string, required
          - `id` string, required
      - `master` ToOneRelationship
        - `data` ResourceIdentifier, required
          - `type` string, required
          - `id` string, required
      - `service` ToOneRelationship
        - `data` ResourceIdentifier, required
          - `type` string, required
          - `id` string, required
      - `resource_instances` ToManyRelationship
        - `data` ResourceIdentifier[], required
          - `type` string, required
          - `id` string, required
      - `labels` ToManyRelationship
        - `data` ResourceIdentifier[], required
          - `type` string, required
          - `id` string, required
      - `duration_details` ToOneRelationship
        - `data` ResourceIdentifier, required
          - `type` string, required
          - `id` string, required
  - `included` IncludedResource[] — Resources requested through `include`, when available
    - `type` string, required
    - `id` string, required
    - `attributes` object, required
    - `relationships` object

## Other responses

- `400` — Required date range is missing
- `401` — Unauthorized
- `403` — Forbidden - No timetable permission for this Location
- `404` — Location not found
- `422` — Invalid date range, filter, or pagination value

---

[API](https://skmtc.net/alteg/apis/business-management.md) · [All operations](https://skmtc.net/alteg/apis/business-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alteg/business-management/revisions/bc9cbcc9c5f1/schema)