Skip to main content
GET
List Top Correspondents

Request

This endpoint is the fastest way to surface the people your team is actively emailing, ranked by recency and volume. It is the data source behind the sidebar’s “Top correspondents” widget.

Query Parameters

integer
default:"25"
Number of correspondents to return. Maximum 200.
string
Optional ISO 8601 lower-bound on the messages considered (e.g. the last 30 days).
string
Scope the aggregation to a single user in the workspace. When omitted, every connected mailbox is aggregated.
integer
default:"2"
Exclude correspondents who have exchanged fewer than this number of messages.

Headers

Response

object
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID headers.

Example Response

Errors