---
title: "Get events"
method: GET
path: "/events"
tags: ["Events"]
---

# Get events

`GET /events`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/events`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Returns a list of events.

## Query parameters

- `Offset` integer
- `Limit` integer
- `UpdatedSince` string
- `MatterId` string
- `ExcludeDeletedEvents` boolean
- `From` string, date-time
- `To` string, date-time

## Response `200`

When request is successful. Returns a paged collection of 'Event' objects.

- EventPagedCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` Event[], nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable: Unique identifier of the event.
    - `matter` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `attendees` Link[], nullable: Hypermedia link of all the attendees.
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `externalAttendees` Link[], nullable: Hypermedia link of all the contacts of the external or third party attendees.
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `eventType` 'Normal' | 'Pattern' | 'Occurrence' | 'ChangedOccurrence' | 'DeletedOccurrence': The type of the event. Possible values: Non Recurring Event = 0, Recurring Pattern Series = 1, Single Recurring Occurrence = 2, Modified Recurring Occurrence = 3, Deleted Recurring Occurrence = 4
    - `type` 'Normal' | 'Pattern' | 'Occurrence' | 'ChangedOccurrence' | 'DeletedOccurrence': The type of the event. Possible values: Non Recurring Event = 0, Recurring Pattern Series = 1, Single Recurring Occurrence = 2, Modified Recurring Occurrence = 3, Deleted Recurring Occurrence = 4
    - `subject` string, nullable: Subject of event.
    - `description` string, nullable: Description of event.
    - `location` string, nullable: Location of event.
    - `allDay` boolean: Whether or not the event is all day.
    - `nonBillable` boolean: Whether or not the event is billable. Note events with a duration greater than 12 hours automatically become non-billable.
    - `startTime` string, date-time: Start date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.
    - `endTime` string, date-time: End date and time of the event. Supported date format is ISO YYYY-MM-DDThh:mm:ss. Note: date and time will correlate with the time zone provided.
    - `timeZone` string, nullable: Time zone of the event for determining the start time and end time. Time zones will be in the IANA time zone format.
    - `lastUpdated` string, date-time: The last date and time the event was updated. Supported date format is ISO YYYY-MM-DDThh:mm:ss.
    - `additionalData` object, nullable: Any additional data provided for the event.
    - `isDeleted` boolean: Whether the event has been deleted.
  - `offset` integer, nullable
  - `limit` integer, nullable
  - `size` integer
  - `first` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `previous` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `next` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `last` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)