v1

OpenAPI 3.0.02026-08-04109109370.6 KB

Events (Timeline)

Get a list of 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.

get/events

Query parameters

max_idstring

Retrieve a feed of events with an ID less than or equal to than the specified ID

since_idstring

Retrieve a feed of events with an ID greater than the specified ID

max_timeinteger

Retrieve a feed of events that occurred before the specified time

since_timeinteger

Retrieve a feed of events that occurred after the specified time

entity_idstring

Retrieve a feed of events related to a specific entity

limitinteger

The number of events to return

eventsstring[]

Opt in to additional event types: comments, mailchimp, followup, constantContact, emailInteraction, assignments, formSubmissions

filters[payload][]string[]

Retrieve a feed of events related to a type of entity

filters[creator][]string[]

Retrieve a feed of events caused by a specific user or team

filters[emailEntityType][]string[]

Whether to receive email sent or received events. Requires a creator filter

Response

A list of events

Example response

{
  "meta": {
    "instanceId": "12345"
  },
  "events": [
    {
      "id": "3-contacts",
      "actorType": "users",
      "payloadType": "contacts",
      "action": "create",
      "changes": [
        {
          "attribute": "value"
        }
      ]
    }
  ]
}