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

Endpoint: GET /locations/{location_id}/events
Version: 2.0.0
Security: BearerPartnerUser

## Security:

  - `BearerPartnerUser` (unknown)
    http bearer Bearer {PartnerToken}, User {UserToken}

## Path parameters:

  - `location_id` (integer, required)
    Location ID

## Query parameters:

  - `filter[from]` (string, required)
    Range start in the Location timezone as `YYYY-MM-DD HH:MM:SS`

  - `filter[to]` (string, required)
    Range end in the Location timezone as `YYYY-MM-DD HH:MM:SS`

  - `filter[master_ids][]` (array)
    Team Member IDs; the literal wire query key is `filter[master_ids][]`

  - `filter[service_ids][]` (array)
    Service IDs

  - `filter[capacity]` (integer)
    Minimum number of unoccupied places

  - `page` (integer)
    Result page

  - `limit` (integer)
    Maximum number of Events to return

  - `include` (array)
    Related resources to include; values are literal API keys

## Header parameters:

  - `Accept` (string, required)
    Required B2B v2 response media type. Use `application/vnd.api.v2+json`. A charset parameter is also accepted.

  - `Authorization` (string, required)
    Bearer {partner_token}, User {user_token}

## Response 200:

  - `200` (unknown)
    Events retrieved successfully

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.type` (string, required)
    Literal JSON:API resource type returned for Events
    Enum: "activity"

  - `data.id` (string, required)
    Event ID

  - `data.attributes` (object, required)

  - `data.attributes.master_id` (integer, required)
    Deprecated wire field for Team Member ID; use `staff_id`

  - `data.attributes.staff_id` (integer, required)
    Team Member ID

  - `data.attributes.service_id` (integer, required)
    Service ID

  - `data.attributes.timestamp` (integer, required)
    Event start as a Unix timestamp

  - `data.attributes.length` (integer, required)
    Event duration in seconds

  - `data.attributes.capacity` (integer, required)
    Total number of available places

  - `data.attributes.clients_count` (integer, required)
    Number of Booking Users currently booked

  - `data.attributes.color` (string, required)
    Event background color including `#`

  - `data.attributes.instructions` (string, required)
    Instructions for Booking Users

  - `data.attributes.stream_link` (string, required)
    Online Event stream link, or an empty string

  - `data.attributes.font_color` (string, required)
    Event text color including `#`

  - `data.attributes.notified` (boolean, required)
    Whether an Event notification was sent

  - `data.attributes.comment` (string | null, required)
    Event comment

  - `data.attributes.deleted` (boolean, required)
    Whether the Event is deleted (a deleted Event stays readable by ID)

  - `data.attributes.schedule_id` (integer | null, required)
    Event Schedule ID

  - `data.attributes.schedule_till` (any, required)
    Event Schedule end represented by the production DateTime wire object

  - `data.attributes.schedule_till.date` (string, required)

  - `data.attributes.schedule_till.timezone_type` (integer, required)

  - `data.attributes.schedule_till.timezone` (string, required)

  - `data.attributes.schedule_event_modified` (boolean | null, required)
    Whether this scheduled Event differs from its Event Schedule

  - `data.attributes.date` (string, required)
    Event start in the Location timezone with a numeric offset

  - `data.relationships` (object)
    Present when related data is requested through `include`

  - `data.relationships.staff` (object)

  - `data.relationships.staff.data` (any, required)

  - `data.relationships.staff.data.type` (string, required)

  - `data.relationships.staff.data.id` (string, required)

  - `data.relationships.resource_instances` (object)

  - `data.relationships.resource_instances.data` (array, required)

  - `included` (array)
    Resources requested through `include`, when available

  - `included.type` (string, required)

  - `included.id` (string, required)

  - `included.attributes` (object, required)

  - `included.relationships` (object)

## Response 400:

  - `400` (unknown)
    Required date range is missing

## Response 400 fields (application/json):

  - `success` (boolean, required)
    Enum: "false"

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `success` (boolean, required)
    Enum: "false"

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable

## Response 403:

  - `403` (unknown)
    Forbidden - No timetable permission for this Location

## Response 403 fields (application/json):

  - `success` (boolean, required)
    Enum: "false"

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable

## Response 404:

  - `404` (unknown)
    Location not found

## Response 404 fields (application/json):

  - `success` (boolean, required)
    Enum: "false"

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable

## Response 422:

  - `422` (unknown)
    Invalid date range, filter, or pagination value

## Response 422 fields (application/json):

  - `success` (boolean, required)
    Enum: "false"

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable