DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

List all activity logs

Example Request & Response

curl https://api.intercom.io/admins/activity_logs?created_at_after=489222000&created_at_before=685695600 \
-X GET \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json'
HTTP/1.1 200 OK
{
    "type": "activity_log.list",
  "pages": {
        "type": "pages",
        "next": nil,
        "page": 1,
        "per_page": 20,
        "total_pages": 1
    },
  "activity_logs": [{
    "id": "6",
    "performed_by": {
        "type": "admin",
        "id": "123456",
        "email": "[email protected]",
        "ip": "127.0.0.1"
    },
    "metadata": {
        "message"; {
        "id": 123,
        "title": "salt&vinegar"
        },
       "before": "before",
       "after": "after"
        },
    "created_at": 1547669358,
    "activity_type": "message_state_change",
    "activity_description"" "Jane Doe changed your salt&vinegar message from before to after."
  }]
}

Example Errors

HTTP/1.1 404 NOT FOUND
{
  "type" => "error.list",
  "request_id" => nil,
  "errors" => [{
    "code" => "parameter_not_found",
    "message" => "Please provide the following parameters: created_at_after"
  }]
}
HTTP/1.1 403 RESTRICTED
{
  "type" => "error.list",
  "request_id" => nil,
  "errors" => [{
    "code" => "api_plan_restricted",
    "message" => "This feature is not yet available to your app"
  }]
}

You can get a log of activities by all admins in an app by sending a GET request to the URL https://api.intercom.io/admins/activity_logs.

Activity List

Attribute

Type

Description

type

string

Value is activity_log.list

activity_logs

array

A list of activity objects

pages

object

Optional. A pagination object which may be empty, indication no further pages to fetch

Activity Object

Attribute

Type

Description

activity_type

string

The type of activity - see Activity Types & Descriptions below.

activity_description

string

A sentence or two describing the activity - see Activity Types & Descriptions below.

metadata

object

An object containing information on the activity and what it modified

created_at

timestamp

The time the activity was performed

performed_by

object

An Admin object of the admin who performed the activity

id

string

The id representing the activity

Activity Types & Descriptions

Type

Description

admin_deletion

An admin was removed from your app

admin_invite_change

The permissions for an invited person to be an admin on your app were changed

admin_invite_creation

Someone was invited to be an admin on your app

admin_invite_deletion

Someone is no longer invited to be an admin on your app

admin_login_failure

An admin tried to login with the wrong credentials

admin_login_success

An admin logged in successfully

admin_logout

An admin logged out

admin_permission_change

The permissions for an admin were changed

app_name_change

The name of your app was changed

admin_away_mode

An admin changed their away mode and conversation reassignment settings

app_timezone_change

The timezone of your app was changed

bulk_export

User or lead data was exported from your app

message_deletion

A message was deleted from your app

message_state_change

A message was changed on your app

campaign_deletion

A campaign was deleted from your app

Request Query Parameters

Parameter

Required?

Description

created_at_after

Yes

The start date that you request data for. It must be formatted as a UNIX timestamp.

created_at_before

No

The end date that you request data for. It must be formatted as a UNIX timestamp.

Response

This will return an Activity List which will contain an array titled activity_logs, in turn containing multiple Activity Objects.