Skip to content

Search Inbox Emails

POST
/inbox/emails/search

Search email threads across one or more mailboxes.

mailboxes is REQUIRED and an empty list is not “all mailboxes” - the inbox is per-mailbox, so an empty list is simply no result. Paging is on the query string, matching the app, because the body is the filter.

Authorizations

Parameters

Query Parameters

page
integer
default: 1 >= 1
page_size
integer
default: 10 >= 1 <= 100

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Filter and page email threads across one or more mailboxes.

object
assigned_to_user_email
Any of:
string
campaign_ids
Any of:
Array<string>
exclude_tag_ids
Any of:
Array<string>
mailboxes
required

Mailbox addresses to search. REQUIRED: the inbox is per-mailbox, and an empty list is not ‘all mailboxes’, it is no result.

Array<string>
>= 1 items
search
Any of:
string
search_emails
Any of:
Array<string>
sort_by
string
default: updated_at
Allowed values: updated_at created_at last_message_at
sort_order
string
default: desc
Allowed values: asc desc
status
Any of:
string
Allowed values: SENT AI_RESPONDED DRAFT
tag_ids
Any of:
Array<string>
updated_after
Any of:
string format: date-time
updated_before
Any of:
string format: date-time

Responses

200

Successful Response

object
data
required

A page of threads, or one thread, exactly as the inbox returns it.

object
items
Array<object>
object
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string