Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Query Parameters

domain
string

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.

address
string

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.

limit
string
default:25

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

cursor
string

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

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

unread
string
default:false

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

Response

Response for status 200

threads
object[]
required

Array of thread objects matching the query, sorted by last message date (newest first)

pagination
object
required

Pagination metadata for cursor-based pagination

filters
object
required

Applied filters for this query