Skip to content
Home/
REST API Reference
/
/
List all data events

List all data events

Request

🚧

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.

Security
bearerAuth
Query
filteruser_id query parameter (object) or intercom_user_id query parameter (object) or email query parameter (object)required
One of:
typestringrequired

The value must be user

summaryboolean

summary flag

Headers
Intercom-Versionstring(intercom_version)

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

Default:"2.9"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.9
curl -i -X GET \
  'https://api.intercom.io/events?filter=user_id%3Dstring&type=string&summary=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.9'

Responses

Successful response

Bodyapplication/json
typestring

The type of the object

Value:"event.summary"
Example:"event.summary"
emailstring

The email address of the user

Example:"Sam.Sung@example.com"
intercom_user_idstring

The Intercom user ID of the user

Example:"63a0979a5eeebeaf28dd56ba"
user_idstring

The user ID of the user

Example:"62b997f288e14803c5006932"
eventsArray of objects(Data Event Summary Item)

A summary of data events

Response
{
  "type": "event.summary",
  "events": [],
  "pages": {
    "next": "http://api.intercom.test/events?next page"
  },
  "email": "user26@email.com",
  "intercom_user_id": "6657aba56abd0164c24b0dbb",
  "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"
}