Intercom API (unofficial showcase)
POST/admins/activity_logs/search

Search admin activity logs

Searches admin activity logs by time range and optional event type filters. Supply created_at_after and use event_types to restrict results to selected event types; retrieve valid event types from the activity log event types endpoint. Use page and per_page to paginate the results.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
Intercom-Versionstringoptional
The Intercom API version to use. Supported versions include the listed values; defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Activity log search criteria, including a required start timestamp and optional filters and pagination settings.

created_at_afterintegerrequired
The start date that you request data for. It must be formatted as a UNIX timestamp.
created_at_beforeintegeroptional
The end date that you request data for. It must be formatted as a UNIX timestamp.
event_typesarray<string>optional
An optional list of event types to filter activity logs by. Use the list all activity log event types endpoint to retrieve available values.
pageintegeroptional
The page number of results to return.
Default:1
per_pageintegeroptional
The number of results per page. Must be between 1 and 250.
Default:20

2 status codes
200Returns a paginated response containing matching activity log entries and page information.
typestringoptional
String representing the object's type. Always has the value `activity_log.list`.
pagesobjectoptional
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
activity_logsarray<ActivityLog>optional
An array of activity logs
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. The body must include created_at_after; per_page must be between 1 and 250, and page defaults to 1 while per_page defaults to 20 when omitted.