Intercom API (unofficial showcase)
GET/events

List data events

Lists data events associated with a user or lead, identified by user_id, email, or intercom_user_id. Set type to user and use summary to request a summary response. You can list individual events only when they are less than 90 days old; summaries can include older events.

4 parameters
filterobjectrequired
Identify the user or lead with exactly one of `user_id`, `email`, or `intercom_user_id`.
typestringrequired
The event subject type; use `user`.
summarybooleanoptional
Whether to request a summary of data events.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns a data event summary for the identified user or lead, including the identifier and an array of event summaries with names, first and last occurrence times, counts, and descriptions.
typestringoptional
The type of the object
Allowed:event.summary
emailstringoptional
The email address of the user
intercom_user_idstringoptional
The Intercom user ID of the user
user_idstringoptional
The user ID of the user
eventsarray<DataEventSummaryItem>optional
A summary of data events
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. Supply filter with exactly one of user_id, email, or intercom_user_id, set type to user, and URL-encode an email value when sending it.