---
title: "Get a list of events"
method: GET
path: "/events"
tags: ["Events (Timeline)"]
---

# Get a list of events

`GET /events`

Retrieve a feed of events. Events, also known as change logs, are a record of everything that happened in Nutshell. They're used to power notifications and timelines among other things.

## Query parameters

- `max_id` string
- `since_id` string
- `max_time` integer
- `since_time` integer
- `entity_id` string
- `limit` integer
- `events` string[]
- `filters[payload][]` string[]
- `filters[creator][]` string[]
- `filters[emailEntityType][]` string[]

## Response `200`

A list of events

- EventResponse — A full response object for an event-related endpoint.
  - `meta` object — Information about the Nutshell instance making the request
    - `instanceId` string — The Nutshell instance ID
    - `siteId` string — Site ID for WebFX customers
    - `previous` string — The URL to the previous page of results
    - `next` string — The URL to the next page of results
  - `events` object[]
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}
    - `createdTime` integer
    - `actorType` string — The type of entity that performed the action.
    - `payloadType` string — The type of entity that was changed
    - `action` string — What type of change took place
    - `changes` object[] — The changed values associated with the event
      - `attribute` string — What value of the entity was changed
      - `oldValue` ChangeLogChange
        - `id` string
        - `type` string
        - `name` string
        - `position` integer
      - `newValue` ChangeLogChange
        - `id` string
        - `type` string
        - `name` string
        - `position` integer
    - `count` string
    - `links` EventLinkIds
      - `actor` string
      - `payloads` string[]
      - `comments` string[] — Returns an array of all potential link configurations for the current object. Supported keys for each link config are: - string type The `type` key of the top-level link configuration. - array groups Which groups this link will be included in; 'base' for all. - array compoundGroups Which groups will include the linked model(s) as compound documents by default. - string urlPrefix Overwrites the `href` link config value with i.e. "https://app01.nutshell.com/rest/$urlPrefix". - boolean isResourceObject If `true`, no top-level link config will be included in the response for this link. Every linked model will be render as a resource object of the form: { id: "ApiId", type: "ApiType", href: "ApiHref" }

---

[API](https://skmtc.net/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.net/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/versions/91e98426903e/schema)