---
title: "Activity history for an inbox"
method: GET
path: "/api/inboxes/{channelId}/history"
tags: ["Inboxes"]
---

# Activity history for an inbox

`GET /api/inboxes/{channelId}/history`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/inboxes/{channelId}/history`
- Auth: one of:
  - API key in header `x-token`
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/inboxes/:channelId/history/get.ts> (a function with typed inputs; its response is checked against the schema)

What happened on the inbox's threads, newest first: status changes,
assignments, folder moves, topic edits and email sends by users, email opens
by recipients, and automation runs.

Without `streamId`, history covers the inbox's 100 most recently active
threads; pass `streamId` to read one thread (including older ones). With
`userId`, only entries that user performed are returned, so email opens and
automation runs (which have no user actor) are left out.

## Path parameters

- `channelId` string, required

## Query parameters

- `streamId` string
- `userId` string
- `limit` integer

## Response `200`

History entries, newest first.

- object
  - `data` object[]
    - `type` string: `threadAssign`, `changeStatus`, `moveToFolder`, `editTopic`, `emailSent` (and other user action types), `openTrackingView` or `automationEvent`.
    - `date` string, date-time
    - `streamId` string: Thread the entry belongs to.
    - `actor` object: `{ id, type }` where type is `user`, `person` or `aptly`; an email opener without a contact record has only `name`.
      - `id` string
      - `type` string
      - `name` string
    - `assignedTo` string: `threadAssign`: the assigned user's id.
    - `message` string: `threadAssign`: the note left with the assignment.
    - `status` unknown
    - `folder` unknown
    - `add` boolean: `editTopic`: true when topics were added, false when removed.
    - `issueTypes` string[]: `editTopic`: the topic label ids.
    - `subject` string: `emailSent`: the email subject.
    - `automationDetails` object: `automationEvent` only.
      - `automationUuid` string
      - `success` boolean
      - `error` string
      - `description` string
      - `actionPerformed` string

## Other responses

- `400`: Invalid `limit`, `streamId` or `userId`.
- `401`: Invalid or missing credential.
- `403`: The authenticated user cannot reach this inbox.
- `404`: Inbox not found in your company, or `streamId` is not a thread in this inbox.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)
