Skip to main content
POST
Search email engagements

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Body

application/json

Request body of search_email_engagements.

filter
object
include
enum<string>[]

Relations to eager-load (see entity Includes).

Available options:
email_message
sort
object
page_size
integer

0..500, default 50. page_size=0 = count-only, page_size=1 = getFirst.

Required range: 0 <= x <= 500
cursor
string | null

Opaque forward cursor from a previous response pagination.next_cursor.

Response

search success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
search
items
object[]
required
pagination
object
required
applied_filters
object
required
includes
string[]
required
meta
object
required
counts
object