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, intercom_user_id or anonymous_id. The type parameter value must be user or lead.

  • 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)

When type is lead, a user_id you send is matched against the lead's anonymous id instead.

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.

Requires the read_events or write_events OAuth scope.

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

The value must be user or lead.

Enum:"user""lead"
per_pageinteger

The number of events to return per page.

sinceinteger, (int64)

Only return events created after this time, as a Unix timestamp in milliseconds. Take the value from the since link in the pages object of a previous response.

beforeinteger, (int64)

Only return events created before this time, as a Unix timestamp in milliseconds. Take the value from the next link in the pages object of a previous response.

summaryboolean

Set to true (or 1) to return an event summary (event.summary) instead of the list of events. Omit for the paginated event list (event.list).

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

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

Responses

Successful response

Bodyapplication/json
One of:

This will return a list of data events for the App.

typestring

The type of the object

Value:"event.list"
Example:"event.list"
eventsArray of objects(Data Event)

A list of data events

pagesobject

Pagination

Response
{
  "type": "event.summary",
  "events": [],
  "email": "user26@email.com",
  "intercom_user_id": "6762f22b1bb69f9f2193bc12",
  "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"
}