API ReferenceInboxesThreads

Search Threads

Full-text search across threads in the inbox, ranked by relevance. The query is matched against senders, recipients, and subject (substring) and the message body (tokenized full text). Spam, trash, blocked, and unauthenticated threads are always excluded. limit cannot exceed 100.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.

Query parameters

qstringRequired

Full-text search query. Matched against the sender, recipients, and subject (substring) and the message body (tokenized full text).

limitintegerOptional
Limit of number of items returned.
page_tokenstringOptional
Page token for pagination.
beforedatetimeOptional
Timestamp before which to filter by.
afterdatetimeOptional
Timestamp after which to filter by.

Response

This endpoint returns an object.
countinteger
Number of items returned.
threadslist of objects
Ordered by relevance, best match first.
limitinteger
Limit of number of items returned.
next_page_tokenstring
Page token for pagination.

Errors

400
Validation Error
404
Not Found Error