Get a list of events

get

https://app.nutshell.com/rest/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 Params

max_id

string

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

since_id

string

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

max_time

integer

Retrieve a feed of events that occurred before the specified time

since_time

integer

Retrieve a feed of events that occurred after the specified time

entity_id

string

Retrieve a feed of events related to a specific entity

limit

integer

The number of events to return

events

array of strings

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

events

Allowed:

filters[payload][]

array of strings

Retrieve a feed of events related to a type of entity

filters[payload][]

filters[creator][]

array of strings

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

filters[creator][]

filters[emailEntityType][]

array of strings

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

filters[emailEntityType][]

Allowed:

Response

200A list of events