API Docs / Operations / Client - Emails / List Emails for Client

List Emails for Client

GET /tenants/{tenant}/clients/{client}/emails

Returns emails associated with this client based on its email rules. Rules containing '@' match that email address, GUIDs pin a specific message, and plain values match all emails from that domain. Searches across mailbox configurations the current user can access (owned or shared). Returns empty results if no rules are configured.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

client* path string
search query string
direction query enum

Represents the direction of an email in the external mailbox

Inbound Outbound

Represents the direction of an email in the external mailbox

Inbound Outbound

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by.

LatestMessageDate Subject MessageCount

Field to sort by.

LatestMessageDate Subject MessageCount

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

Responses

401 Unauthorized – Invalid or missing API key