Search EmailAccounts - Nexudus Platform

GET

api

crm

emailaccounts

Search EmailAccounts

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

{
  "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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

EmailAccount_Business

integer

Filter by iD of the business linked to this record.

EmailAccount_DisplayName

string

Filter by the display name value for this email account.

EmailAccount_EmailAddress

string

Filter by the email address value for this email account.

EmailAccount_Active

boolean

Filter by whether this email account is currently active.

EmailAccount_SendNotificationOnNewMessages

boolean

Filter by whether send notification on new messages is enabled.

EmailAccount_NotificationEmailAddress

string

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

EmailAccount_IncomingServer

string

Filter by the incoming server value for this email account.

EmailAccount_IncomingServerType

integer

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

EmailAccount_IncomingServerPort

integer

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

EmailAccount_IncomingServerSSL

boolean

Filter by whether incoming server ssl is enabled.

EmailAccount_IncomingServerUsername

string

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

EmailAccount_DeleteMessageSettings

integer

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

EmailAccount_OutgoingServer

string

Filter by the outgoing server value for this email account.

EmailAccount_OutgoingServerPort

integer

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

EmailAccount_OutgoingServerSSL

boolean

Filter by whether outgoing server ssl is enabled.

EmailAccount_OutgoingServerUsername

string

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

EmailAccount_ReplyToEmail

string

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

EmailAccount_LastCheckTime

string

Filter by date/time value for last check time.

EmailAccount_LastMessageId

integer

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

EmailAccount_ErrorCount

integer

Filter by the error count value for this email account.

EmailAccount_GoogleAccessToken

string

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

EmailAccount_Office365AccessToken

string

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

Range Filters

from_EmailAccount_IncomingServerPort

integer

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

to_EmailAccount_IncomingServerPort

integer

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

from_EmailAccount_OutgoingServerPort

integer

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

to_EmailAccount_OutgoingServerPort

integer

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

from_EmailAccount_LastCheckTime

string

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

to_EmailAccount_LastCheckTime

string

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

from_EmailAccount_LastMessageId

integer

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

to_EmailAccount_LastMessageId

integer

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

from_EmailAccount_ErrorCount

integer

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

to_EmailAccount_ErrorCount

integer

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

from_EmailAccount_CreatedOn

string

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

to_EmailAccount_CreatedOn

string

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

from_EmailAccount_UpdatedOn

string

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

to_EmailAccount_UpdatedOn

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"

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"

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"

Response

200

Records

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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

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>'

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

​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