Email Accounts
List Email Accounts
GET
/v1/email-accountsGET
/v1/email-accounts
List Connected Email Accounts
Retrieve all connected email accounts for the sub-account with their current status (active, warming, paused, error, auth-expired). Supports search, pagination, and sorting.
Authorization
X-Api-Key<token>
In: header
Query Parameters
searchstring
Search by email address or name
sortstring
Default: "createdAt"Value in: "createdAt" | "fromEmail" | "fromName"sortBystring
Sort direction
Default:"DESC"Value in: "ASC" | "DESC"statusstring
Filter by account status: active (connected, not warming), warming (warmup running), paused, error, auth-expired
Value in:"active" | "warming" | "paused" | "error" | "auth-expired"tagsarray<string>
Filter by tag name. Returns accounts carrying any of the given tags. Repeat the parameter for multiple tags (e.g. ?tags=Q3-outreach&tags=US).
Responses
200
200 response
{
"items": [
{
"id": 0,
"fromEmail": "string",
"fromName": "string",
"type": "gmail",
"status": "active",
"createdAt": "string",
"workspaceId": null,
"tags": [
"Q3-outreach",
"US"
]
}
],
"total": 0,
"page": 0,
"limit": 0,
"totalPages": 0
}