Skip to main content
GET
/
api
/
crm
/
emailaccounts
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​
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.

​
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. 1 for ascending, -1 for descending.

​
Filters

​
EmailAccount_Business
integer
Filter by Business Id.
​
EmailAccount_DisplayName
string
Filter by Display Name.
​
EmailAccount_EmailAddress
string
Filter by Email Address.
​
EmailAccount_Active
boolean
Filter by Active.
​
EmailAccount_SendNotificationOnNewMessages
boolean
Filter by Send Notification On New Messages.
​
EmailAccount_NotificationEmailAddress
string
Filter by Notification Email Address.
​
EmailAccount_IncomingServer
string
Filter by Incoming Server.
​
EmailAccount_IncomingServerType
integer
Filter by Incoming Server Type.
​
EmailAccount_IncomingServerPort
integer
Filter by Incoming Server Port.
​
EmailAccount_IncomingServerSSL
boolean
Filter by Incoming Server SSL.
​
EmailAccount_IncomingServerUsername
string
Filter by Incoming Server Username.
​
EmailAccount_DeleteMessageSettings
integer
Filter by Delete Message Settings.
​
EmailAccount_OutgoingServer
string
Filter by Outgoing Server.
​
EmailAccount_OutgoingServerPort
integer
Filter by Outgoing Server Port.
​
EmailAccount_OutgoingServerSSL
boolean
Filter by Outgoing Server SSL.
​
EmailAccount_OutgoingServerUsername
string
Filter by Outgoing Server Username.
​
EmailAccount_ReplyToEmail
string
Filter by Reply To Email.
​
EmailAccount_LastCheckTime
string
Filter by Last Check Time.
​
EmailAccount_LastMessageId
integer
Filter by Last Message Id.
​
EmailAccount_ErrorCount
integer
Filter by Error Count.
​
EmailAccount_GoogleAccessToken
string
Filter by Google Access Token.
​
EmailAccount_Office365AccessToken
string
Filter by Office365Access Token.

​
Range Filters

​
from_EmailAccount_IncomingServerPort
integer
Filter by incoming server port greater than or equal to this value.
​
to_EmailAccount_IncomingServerPort
integer
Filter by incoming server port less than or equal to this value.
​
from_EmailAccount_OutgoingServerPort
integer
Filter by outgoing server port greater than or equal to this value.
​
to_EmailAccount_OutgoingServerPort
integer
Filter by outgoing server port less than or equal to this value.
​
from_EmailAccount_LastCheckTime
string
Filter by last check time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_EmailAccount_LastCheckTime
string
Filter by last check time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_EmailAccount_LastMessageId
integer
Filter by last message id greater than or equal to this value.
​
to_EmailAccount_LastMessageId
integer
Filter by last message id less than or equal to this value.
​
from_EmailAccount_ErrorCount
integer
Filter by error count greater than or equal to this value.
​
to_EmailAccount_ErrorCount
integer
Filter by error count 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=1" \
  -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=1" \
  -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=-1" \
  -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 included 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 (1 = 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,
      "SendNotificationOnNewMessages": false,
      "NotificationEmailAddress": null,
      "IncomingServer": "",
      "IncomingServerType": 0,
      "IncomingServerPort": 0,
      "IncomingServerSSL": false,
      "IncomingServerUsername": "",
      "DeleteMessageSettings": 0,
      "OutgoingServer": "",
      "OutgoingServerPort": 0,
      "OutgoingServerSSL": false,
      "OutgoingServerUsername": "",
      "ReplyToEmail": null,
      "LastCheckTime": null,
      "LastMessageId": 0,
      "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
}