Home
/
REST API Reference
/
Data Events
/
List all 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.

SecurityHTTP: bearerAuth
Request
query Parameters
required
user_id query parameter (object) or intercom_user_id query parameter (object) or email query parameter (object)
type
required
string

The value must be user

summary
boolean

summary flag

header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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

Enum: "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" "Unstable"
Example: 2.10
get
/events
Request samples
Responses
200
Successful response
Response Schema: application/json
type
string 
The type of the object
 Value: "event.summary"  
email
string 
The email address of the user
 
intercom_user_id
string 
The Intercom user ID of the user
 
user_id
string 
The user ID of the user
 
Array of objects or null (Data Event Summary Item)  
A summary of data events
 
401
Unauthorized
Response samples
application/json
{
"type": "event.summary",
"events": [ ],
"pages": {
"next": "http://api.intercom.test/events?next page"
},
"email": "user26@email.com",
"intercom_user_id": "660e73646abd01bd27af61f3",
"user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"
}