Skip to main content
POST
Search mailbox directory

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.

Body

application/json

Request body of search_email_account_directory.

filter
object
sort
object

Default address, ascending. No label and no connected_at come first ascending, last descending.

page_size
integer

0..500, default 50. 0 = counts only.

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

pagination.next_cursor of the previous page.

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