Inboxes

List threads and messages on an inbox

Returns threads on the inbox, newest activity first, each with its messages and stored per-thread metrics. Paging is over threads, not individual messages.

The window filters on the thread's last message time and dateTo is exclusive. Automated/junk threads are excluded unless includeJunk=true.

sentVia indicates whether an outbound was composed in Aptly (aptly) or sent from the user's own mail client and synced in (native). Inbound messages are always null.

get/api/inboxes/{channelId}/threads

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/inboxes/:channelId/threads/get.ts
A 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

dateFromstring date-time

ISO date. Only threads with activity at or after this time.

dateTostring date-time

ISO date, exclusive. Range must not exceed 400 days.

direction'in' | 'out'

Filter to threads whose most recent message went this way.

unreadOnlyboolean

When true, return only unread threads. Unread is the thread's stored read state, a single flag shared by everyone with access to the inbox (a thread any teammate has opened counts as read). Applied before paging, so count reflects the filtered total.

includeJunkboolean

Include threads classified as junk/automated.

pageinteger

Zero-based page number (0–9999).

pageSizeinteger

Threads per page.

Response

Threads with their messages and metrics.

countinteger

Total matching threads across all pages.