Inboxes
Activity history for an inbox
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.
get/api/inboxes/{channelId}/history
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
channelIdstring required
External channel meta ID (meta.id) of the inbox.
Query parameters
streamIdstring
Only this thread. Must belong to the inbox.
userIdstring
Only entries performed by this Aptly user.
limitinteger
Maximum entries returned.
Response
History entries, newest first.
Changes
No recorded changes to this operation across all 1 revision of this API.