v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Email Accounts

List email accounts

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

Returns a paginated list of email accounts. By default returns all email accounts visible to the authenticated user, including team members' accounts in Public or Organization mode. Use my=true to restrict results to only the authenticated user's own accounts.

get/v3/email-accounts

Query parameters

topinteger

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

skipinteger

Number of items to skip

myboolean

When false (default), returns all email accounts visible to the authenticated user:

  • In Public or Organization mode: all team members' accounts.
  • In Private mode: only the team owner sees all accounts; regular members see only their own. When true, returns only the authenticated user's own email accounts regardless of team mode.

Response

Paginated list of 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"
      ]
    }
  ]
}