Search EmailAccounts

GET

api

crm

emailaccounts

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/emailaccounts \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/crm/emailaccounts"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/emailaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

An EmailAccount configures an incoming email connection (IMAP) used to receive messages for the help desk or other automated workflows. Each account specifies server connection details, credentials, and message handling policies.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the EmailAccount-List role.

Enums

eEmailServerType — IncomingServerType values

Value	Name
1	Imap

eMessageDeletionPolicy — DeleteMessageSettings values

Value	Name
1	DontDelete
2	DeleteOnReceive
3	DeleteWhenDeleting

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the business linked to this record.

string

Filter by the display name value for this email account.

string

Filter by the email address value for this email account.

boolean

Filter by whether this email account is currently active.

boolean

Filter by whether send notification on new messages is enabled.

string

Filter by the notification email address value for this email account.

string

Filter by the incoming server value for this email account.

integer

Filter by the incoming server type value for this email account.

integer

Filter by the incoming server port value for this email account.

boolean

Filter by whether incoming server ssl is enabled.

string

Filter by the incoming server username value for this email account.

integer

Filter by the delete message settings value for this email account.

string

Filter by the outgoing server value for this email account.

integer

Filter by the outgoing server port value for this email account.

boolean

Filter by whether outgoing server ssl is enabled.

string

Filter by the outgoing server username value for this email account.

string

Filter by the reply to email value for this email account.

string

Filter by date/time value for last check time.

integer

Filter by iD of the last message associated with this record.

integer

Filter by the error count value for this email account.

string

Filter by the google access token value for this email account.

string

Filter by the office365 access token value for this email account.

Range Filters

integer

Filter by the incoming server port value for this email account greater than or equal to this value.

integer

Filter by the incoming server port value for this email account less than or equal to this value.

integer

Filter by the outgoing server port value for this email account greater than or equal to this value.

integer

Filter by the outgoing server port value for this email account less than or equal to this value.

string

Filter by date/time value for last check time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last check time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by iD of the last message associated with this record greater than or equal to this value.

integer

Filter by iD of the last message associated with this record less than or equal to this value.

integer

Filter by the error count value for this email account greater than or equal to this value.

integer

Filter by the error count value for this email account less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/crm/emailaccounts?page=1&size=15&orderBy=DisplayName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/emailaccounts?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'DisplayName',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/emailaccounts',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'DisplayName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by DisplayName

curl -X GET \
  "https://spaces.nexudus.com/api/crm/emailaccounts?EmailAccount_DisplayName=example-value&orderBy=DisplayName&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/emailaccounts?' + new URLSearchParams({
    EmailAccount_DisplayName: 'example-value',
    orderBy: 'DisplayName',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/emailaccounts',
    params={
        'EmailAccount_DisplayName': 'example-value',
        'orderBy': 'DisplayName',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/crm/emailaccounts?from_EmailAccount_UpdatedOn=2025-01-01T00:00&to_EmailAccount_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/emailaccounts?' + new URLSearchParams({
    from_EmailAccount_UpdatedOn: '2025-01-01T00:00',
    to_EmailAccount_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/emailaccounts',
    params={
        'from_EmailAccount_UpdatedOn': '2025-01-01T00:00',
        'to_EmailAccount_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

EmailAccount[]

The list of EmailAccount records matching the query. See the Get one EmailAccount endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each EmailAccount. The following fields are not populated in the Records[] response: SendNotificationOnNewMessages, NotificationEmailAddress, IncomingServer, IncomingServerType, IncomingServerPort, IncomingServerSSL, IncomingServerUsername, DeleteMessageSettings, OutgoingServer, OutgoingServerPort, OutgoingServerSSL, OutgoingServerUsername, ReplyToEmail, LastCheckTime, LastMessageId.To get all fields, fetch the full record using the Get one EmailAccount endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "DisplayName": "",
      "EmailAddress": "",
      "Active": false,
      "ErrorCount": 0,
      "GoogleAccessToken": null,
      "Office365AccessToken": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "EmailAccount Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "DisplayName",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one EmailAccountRetrieve a single EmailAccount record by its Id.

Search EmailAccounts

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/emailaccounts \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/crm/emailaccounts"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/crm/emailaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by DisplayName

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by DisplayName

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by DisplayName

Range filters

Response

200