List all contact activities

Request

You can fetch a list of contact activity events for your workspace, such as when contacts are created, role updated, merged, or deleted. Events are returned oldest first.

If the activity store can't be read, this endpoint returns 200 with an empty data array and no pages.next, the same response as when there are no new events.

Pagination

You can use pagination to limit the number of results returned. The default is 50 results per page, with a maximum of 150. See the pagination section for more details on how to use the starting_after param.

Requires the read_users_companies or read_write_users OAuth scope.

Security

bearerAuth

Query

per_pageinteger, [ 1 .. 150 ]

The number of results to return per page. Defaults to 50, minimum 1, maximum 150; larger values are treated as 150. Only the leading digits are read, so 1.5 is treated as 1. A value that doesn't start with a positive integer, such as 0 or abc, returns a 400 error with code invalid_per_page.

Default:50

starting_afterstring

The cursor value from pages.next.starting_after in a previous response. Used to paginate through results.

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:2.17

curl -i -X GET \
  'https://api.intercom.io/contacts/activities?per_page=50&starting_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.17'

Responses

successful

Bodyapplication/json

typestring

Always list

Value:"list"

Example:"list"

dataArray of objects(Contact Activity)

The list of contact activity objects.

pagesobject

Pagination information.

Response

{
  "type": "list",
  "data": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "pages": {
    "type": "pages",
    "per_page": 5,
    "next": { … }
  }
}