Docs
Email Accounts

List email accounts

GET
/v2/workspaces/{workspaceId}/accounts

Path Parameters

workspaceIdnumber

Query Parameters

page?number
Default1
Range1 <= value <= 100000
limit?number
Default25
Range1 <= value <= 100
status?array<string>
Value in"all" | "active" | "throttled" | "paused" | "suspended" | "maintenance" | "disconnected"
provider?array<string>
Value in · 14 values
  • all
  • gmail
  • google_workspace
  • outlook
  • ms365
  • smtp
  • zoho
  • yahoo
  • sendgrid
  • mailgun
  • amazon_ses
  • elastic_email
  • yandex
  • godaddy
q?string

Search email address or display name

sortBy?string
Default"createdAt"
Value in"email" | "status" | "score" | "createdAt"
sortDir?string
Default"desc"
Value in"asc" | "desc"
tags?array<string>

Filter accounts by tag name (OR match across the given names).

esp?string

Filter by ESP mode (auto = AUTO, custom = CUSTOM).

Value in"auto" | "custom"
maxLimitMin?number

Min warmupMaxLimit.

Range5 <= value <= 100
maxLimitMax?number

Max warmupMaxLimit. Must be >= maxLimitMin.

Range5 <= value <= 100
domain?string

Filter by email domain (exact match, case-insensitive).

startDateFrom?string

Pool-entry date lower bound (YYYY-MM-DD, inclusive).

startDateTo?string

Pool-entry date upper bound (YYYY-MM-DD, inclusive). Must be >= startDateFrom.

deliverabilityMin?number

Min deliverabilityRate.

Range0 <= value <= 100
deliverabilityMax?number

Max deliverabilityRate. Must be >= deliverabilityMin.

Range0 <= value <= 100
espGoogleMin?number

Min espGooglePct.

Range0 <= value <= 100
espGoogleMax?number

Max espGooglePct. Must be >= espGoogleMin.

Range0 <= value <= 100
espMicrosoftMin?number

Min espMicrosoftPct.

Range0 <= value <= 100
espMicrosoftMax?number

Max espMicrosoftPct. Must be >= espMicrosoftMin.

Range0 <= value <= 100
espOthersMin?number

Min espOthersPct.

Range0 <= value <= 100
espOthersMax?number

Max espOthersPct. Must be >= espOthersMin.

Range0 <= value <= 100
outreachReadiness?array<string>
Value in"ready" | "warming" | "not_ready"
setupScoreMin?number

Min Setup Score percent.

Range0 <= value <= 100
setupScoreMax?number

Max Setup Score percent. Must be >= setupScoreMin.

Range0 <= value <= 100

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts?page=1&limit=25&status=all&provider=all&q=string&sortBy=email&sortDir=asc&tags=string&esp=auto&maxLimitMin=5&maxLimitMax=5&domain=string&startDateFrom=string&startDateTo=string&deliverabilityMin=100&deliverabilityMax=100&espGoogleMin=100&espGoogleMax=100&espMicrosoftMin=100&espMicrosoftMax=100&espOthersMin=100&espOthersMax=100&outreachReadiness=ready&setupScoreMin=100&setupScoreMax=100"
{
  "data": [
    {
      "id": 0,
      "emailAddress": "string",
      "senderName": "string",
      "provider": "string",
      "authMethod": "string",
      "status": "string",
      "accountState": "string",
      "statusBucket": "string",
      "sendCheckFailed": true,
      "receiveCheckFailed": true,
      "structuredStatus": {},
      "warmupStatus": "string",
      "warmupPausedAt": "2019-08-24T14:15:22Z",
      "warmupPausedReason": "string",
      "throttleReason": "string",
      "cooldownUntil": "2019-08-24T14:15:22Z",
      "warmupMinLimit": 0,
      "warmupMaxLimit": 0,
      "warmupCurrentLimit": 0,
      "warmupRampupDay": 0,
      "warmupStrategy": "string",
      "timezone": "string",
      "poolTier": "string",
      "deliverabilityRate": 0,
      "spfData": {},
      "dkimData": {},
      "dmarcData": {},
      "mxRecordData": {},
      "dnsCheckedAt": "2019-08-24T14:15:22Z",
      "setupScore": 82,
      "inboxPlacementScore": 0,
      "lastVerifiedAt": "2019-08-24T14:15:22Z",
      "pushNotificationsActive": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "source": "string",
      "dwdWorkspaceId": 0,
      "partnerIntegrationId": 0,
      "domainRegisteredAt": "2019-08-24T14:15:22Z",
      "mailboxCreatedAt": "2019-08-24T14:15:22Z",
      "warmupStartDate": "2019-08-24T14:15:22Z",
      "replyRate": 0,
      "warmupPreference": "string",
      "contentIndustry": "string",
      "contentTopics": [
        "string"
      ],
      "contentLanguage": "string",
      "blacklistedAt": "2019-08-24T14:15:22Z",
      "blacklistSource": "string",
      "todaySent": 0,
      "todayReceived": 0,
      "sevenDaySent": 0,
      "sevenDayReceived": 0,
      "tags": [
        {
          "id": 0,
          "name": "string",
          "color": "string"
        }
      ],
      "activeBulkJobId": "string",
      "activeImportId": "string"
    }
  ],
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "pagination": {
    "page": 0,
    "per_page": 0,
    "total": 0,
    "total_pages": 0,
    "has_more": true
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Assign or unassign tags in bulkPOST

Assign and/or unassign tags across multiple accounts One route covers both directions: `addTags` are applied to every selected account (created on demand if the tag name is new), `removeTags` are stripped from every selected account. Both are optional - send either, or both in the same call. Tags are addressed by NAME, not id. Ids outside the caller workspace are filtered out before anything is applied, so `accounts` in the response can be lower than the number of ids sent.

Connect an email accountPOST

Connects a custom SMTP/IMAP mailbox to the workspace. The credentials are verified against both hosts before anything is written, and the password is encrypted at rest. OAuth providers (Gmail / Outlook) are connected through the browser consent flow, not this endpoint.