NUnureply
Email Accounts

List all connected email accounts (sending inboxes)

Retrieve all email accounts associated with your organization, with support for pagination, filtering, search, and sorting.

Filter Descriptions:

  • active: Accounts with both accountStatus and sendingStatus "ready", no errors, and not disabled
  • warmup: Accounts with warmup enabled
  • issues: Accounts with status != "ready" or have errors
  • disabled: Accounts that are disabled
  • all: All accounts (default)
get/v3/user-api/accounts

Request

  • Base URL
    https://api.nureply.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-personal-api-key

Headers

x-personal-api-keystring required

API Key from Dashboard

Response

messagestring required
totalnumber required

Example response

{
  "message": "Retrieved email accounts successfully",
  "data": [
    {
      "_id": "653a2b0bf5444e11e5cdd1ce",
      "address": "sender@example.com",
      "senderName": "John Doe",
      "imapServer": "imap.example.com",
      "imapPort": 993,
      "smtpServer": "smtp.example.com",
      "smtpPort": 465,
      "security": "TLS",
      "dailySendingLimit": 50,
      "dailySendingLimitRemaining": 35,
      "emailsSentToday": 15,
      "trackingDomain": "track.example.com",
      "trackingDomainStatus": "active",
      "accountStatus": "ready",
      "sendingStatus": "ready",
      "accountHealth": 95,
      "warmUpDetails": {
        "maximumWarmUpPerDay": 30,
        "minimumWarmUpStartEmails": 5,
        "warmUpStableDays": 7,
        "warmUpPerDayRemaining": 30,
        "warmUpStartDate": "2023-10-20T10:30:35.624Z"
      },
      "dkimDetails": {
        "status": "pass",
        "message": "DKIM authentication passed"
      },
      "spfDetails": {
        "status": "pass",
        "message": "DKIM authentication passed"
      },
      "dmarcDetails": {
        "status": "pass",
        "message": "DKIM authentication passed"
      },
      "tags": [
        "sales",
        "outbound"
      ],
      "signature": "Best regards,<br>John Doe",
      "createdAt": "2023-10-26T10:30:35.624Z",
      "updatedAt": "2023-10-26T10:30:35.624Z",
      "id": "653a2b0bf5444e11e5cdd1ce"
    }
  ],
  "total": 15,
  "counts": {
    "all": 15,
    "active": 12,
    "warmup": 5,
    "issues": 2,
    "disabled": 1
  },
  "pagination": {
    "page": 1,
    "limit": 12,
    "totalPages": 2,
    "hasMore": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.