SAsaleshandy
email-accounts

Fetch all Email accounts

post/v1/email-accounts

Request

Request body

searchstring

Search term for filtering email accounts based on email or firstName or lastName

pageSizenumber

Number of items per page. Maximum pageSize is 100.

pagenumber

Page number for pagination. Defaults to the first page.

sortByKey'created-date' | 'health-score' | 'remaining-quota' | 'clientFirstName'
sort'ASC' | 'DESC'

Sort order for the results, either ascending or descending.

statusnumber

Filter email accounts by status. 0 for Inactive, 1 for Active, 2 for Suspended.

emailServiceProviderstring[]

List of email service providers associated with the email accounts.

Example request

{
  "search": "john.doe@example.com",
  "pageSize": 25,
  "page": 1,
  "sort": "DESC",
  "sequenceIds": [
    "JA5YdAr9wy"
  ],
  "clientIds": [
    "JA5YdAr9wy"
  ],
  "addedBy": [
    "JA5YdAr9wy"
  ],
  "status": 1,
  "emailServiceProvider": [
    "gsuite",
    "microsoft"
  ]
}

Response

Successfully fetched all email account list

connectedEmailsCountnumber

Number of connected email accounts

disconnectedEmailsCountnumber

Number of disconnected email accounts

Example response

{
  "emails": [
    {
      "id": "XdPd8p1PVo",
      "fromName": "John Doe",
      "fromEmail": "johndoe+4@saleshandy.com",
      "type": 3,
      "status": 1,
      "createdAt": "2024-08-28T04:42:10.131Z",
      "healthScore": 55,
      "user": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "sequences": [
        {
          "id": "JA5YdAr9wy",
          "title": "Sample Sequence",
          "active": true,
          "steps": [
            {
              "id": "bwOLEx4l8G",
              "name": "Step 1"
            }
          ],
          "client": {
            "id": "g9bzZq4aMd",
            "companyName": "Demo",
            "firstName": "John",
            "lastName": "Doe"
          },
          "user": {
            "id": 1,
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com"
          }
        }
      ],
      "settings": [
        {
          "id": "OqwmgYpLaj",
          "code": "available-quota",
          "value": "6",
          "modifiedAt": "2024-10-01T13:00:01.187Z"
        }
      ],
      "client": {
        "id": "g9bzZq4aMd",
        "firstName": "john",
        "lastName": "doe",
        "email": "johndoe+5@saleshandy.com",
        "status": "active",
        "companyName": "Demo"
      },
      "hashId": "XdPd8p1PVo"
    }
  ],
  "meta": {
    "totalItems": 1,
    "currentPage": 1,
    "itemsPerPage": 25,
    "totalPages": 1,
    "itemCount": 1
  },
  "connectedEmailsCount": 1
}

Changes

No recorded changes to this operation across all 4 revisions of this API.