Beta
This endpoint is in beta and may not be available for all organizations.
Returns recent email messages for a candidate, newest first. A request without a cursor starts a point-in-time snapshot containing at most 200 matching messages.
Continue with nextCursor while moreDataAvailable is true, repeating the same candidateId, direction, sentAfter, and watermark values on every request. Omit cursor to start a new snapshot that includes the latest available messages. snapshotTruncated means additional older matching messages may exist beyond the snapshot's 200-message window.
When refreshing after a candidateRecentEmailMessagesUpdated webhook, pass data.watermark unchanged and omit cursor. Only a request with that watermark is guaranteed to include the up-to-date email change that triggered the webhook. The watermark applies only to that candidate and is valid for starting the first page for one hour from the delivery attempt. If the first page is accepted within the hour, remaining pages can complete after the watermark expires.
Pages may be shorter than limit because response byte limits and body truncation apply. Message bodies contain untrusted HTML and must be sanitized before rendering. bodyTruncated indicates that Ashby shortened a body to satisfy response-size limits.
Error codes:
| Code | Description |
|---|---|
response_too_large | A one-message response still exceeds the response safety limit after body truncation. |
watermark_expired | The watermark is older than one hour and this is a cursorless first-page request. |
recordId is not a durable message identifier; do not persist it as one. source indicates where the returned content came from (ashby, sync, import, or public_api). BCC may be null when unavailable. For emails sent through Ashby, receivedReply is true when a reply was received, false when no reply is recorded, and null when unavailable or not applicable. A non-null sequenceId identifies the sourcing sequence associated with the message and matches the id returned by sequence.list; it is null when no sourcing sequence is available.
See the Pagination and Incremental Synchronization guide for general cursor usage.
Requires the emailsRead permission.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||