Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Email Accounts

Filter email accounts

<small>Requires the channels:read scope (or a broader one that includes it).</small>

Returns a paginated list of email accounts matching the provided filter criteria. In Public or Organization mode, results include all team members' accounts. Use ownerUserIds filter to restrict by specific users. When no accounts match the filter, the response contains an empty items array with hasMore: false — this is normal behavior, not an error.

post/v3/email-accounts/filter

Query parameters

topinteger

Maximum number of items to return (default 25, max 1000)

skipinteger

Number of items to skip

Request body

status'connected' | 'disconnected' | 'unknown' nullable

Filter by connection status (case-insensitive, exact match). Allowed values: connected, disconnected, unknown

emailAccountTypestring nullable

Filter by email account provider type (case-insensitive, exact match). Allowed values: Custom, Gmail, Outlook, Exchange, ExchangeOnPremise

emailstring nullable

Filter by email address (exact match, case-insensitive)

domainsstring[] nullable

Filter by email domains (suffix match on the email address). Multiple domains are combined with OR logic — matches any of the provided domains.

ownerUserIdsinteger[] nullable

Filter by owner user IDs (matches any of the provided IDs)

tagsstring[] nullable

Filter by tag names (case-insensitive, matches any of the provided tags)

Example request

{
  "status": "connected",
  "emailAccountType": "Gmail",
  "domains": [
    "company.com"
  ],
  "tags": [
    "Marketing"
  ]
}

Response

Paginated list of matching email accounts

hasMoreboolean

Whether more items are available beyond the current page

Example response

{
  "items": [
    {
      "id": 12345,
      "ownerUserId": 42,
      "email": "john.doe@company.com",
      "senderName": "John Doe",
      "emailAccountType": "gmail",
      "isDefault": true,
      "dailyLimit": 500,
      "connectionStatus": "connected",
      "tags": [
        "Marketing",
        "Outbound"
      ]
    }
  ]
}