v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Data Events

List all data events

🚧

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

  • https://api.intercom.io/events?type=user&user_id={user_id}
  • https://api.intercom.io/events?type=user&email={email}
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)

The email parameter value should be url encoded when sending.

You can optionally define the result page size as well with the per_page parameter.

get/events

Query parameters

OR
OR
typestring required

The value must be user

summaryboolean

summary flag

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

Successful response

type'event.summary'

The type of the object

emailstring

The email address of the user

intercom_user_idstring

The Intercom user ID of the user

user_idstring

The user ID of the user

Example response

{
  "type": "event.summary",
  "email": "Sam.Sung@example.com",
  "intercom_user_id": "63a0979a5eeebeaf28dd56ba",
  "user_id": "62b997f288e14803c5006932",
  "events": [
    {
      "name": "placed-order",
      "first": "2014-01-16T23:12:21.000+00:00",
      "last": "2014-01-16T23:12:21.000+00:00 ",
      "count": 1,
      "description": "A user placed an order"
    }
  ]
}