v1

latestOpenAPI 3.1.02026-07-13350232.8 KB
Inbox

List inbox threads

List email threads (conversations) for your inbox with cursor-based pagination. This is the primary endpoint for building an inbox UI.

What is a Thread? A thread groups related emails together based on the In-Reply-To and References headers, similar to how Gmail groups conversations. Each thread contains both inbound (received) and outbound (sent) messages.

Use with /mail/threads/:id: Use this endpoint to list threads, then use GET /mail/threads/:id to fetch all messages in a specific thread.

get/api/e2/mail/threads

Query parameters

domainstring

Filter threads by domain. Accepts domain ID (e.g., 'dom_xxx') or domain name (e.g., 'example.com'). Returns threads where any participant email matches the domain.

addressstring

Filter threads by email address. Accepts address ID (e.g., 'addr_xxx') or raw email address (e.g., 'user@example.com'). Returns threads where the address is a participant.

limitstring

Maximum number of threads to return (1-100). Default is 25.

cursorstring

Cursor for pagination. Pass the thread ID from pagination.next_cursor of the previous response to get the next page.

searchstring

Search query to filter threads by subject or participant emails. Case-insensitive partial match.

unreadstring

Filter by unread status. Set to 'true' to only return threads with unread messages.

Response

Response for status 200