Get one EmailAccount

GET

api

crm

emailaccounts

{id}

Get one EmailAccount

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "DisplayName": "<string>",
  "EmailAddress": "<string>",
  "Active": true,
  "SendNotificationOnNewMessages": true,
  "NotificationEmailAddress": "<string>",
  "IncomingServer": "<string>",
  "IncomingServerType": 123,
  "IncomingServerPort": 123,
  "IncomingServerSSL": true,
  "IncomingServerUsername": "<string>",
  "DeleteMessageSettings": 123,
  "OutgoingServer": "<string>",
  "OutgoingServerPort": 123,
  "OutgoingServerSSL": true,
  "OutgoingServerUsername": "<string>",
  "ReplyToEmail": "<string>",
  "LastCheckTime": "<string>",
  "LastMessageId": 123,
  "ErrorCount": 123,
  "GoogleAccessToken": "<string>",
  "Office365AccessToken": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the EmailAccount record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/crm/emailaccounts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/emailaccounts/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/emailaccounts/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

The display name value for this email account.

string

The email address value for this email account.

boolean

Whether this email account is currently active.

boolean

Whether send notification on new messages is enabled.

string

The notification email address value for this email account.

string

The incoming server value for this email account.

integer

The incoming server type value for this email account. See eEmailServerType enum values: 1 = Imap.

integer

The incoming server port value for this email account.

boolean

Whether incoming server ssl is enabled.

string

The incoming server username value for this email account.

integer

The delete message settings value for this email account. See eMessageDeletionPolicy enum values: 1 = DontDelete, 2 = DeleteOnReceive, 3 = DeleteWhenDeleting.

string

The outgoing server value for this email account.

integer

The outgoing server port value for this email account.

boolean

Whether outgoing server ssl is enabled.

string

The outgoing server username value for this email account.

string

The reply to email value for this email account.

string

Date/time value for last check time.

integer

ID of the last message associated with this record.

integer

The error count value for this email account.

string

The google access token value for this email account.

string

The office365 access token value for this email account.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

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

Get multiple EmailAccountsRetrieve multiple EmailAccount records by their Ids in a single request.

Get one EmailAccount

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "DisplayName": "<string>",
  "EmailAddress": "<string>",
  "Active": true,
  "SendNotificationOnNewMessages": true,
  "NotificationEmailAddress": "<string>",
  "IncomingServer": "<string>",
  "IncomingServerType": 123,
  "IncomingServerPort": 123,
  "IncomingServerSSL": true,
  "IncomingServerUsername": "<string>",
  "DeleteMessageSettings": 123,
  "OutgoingServer": "<string>",
  "OutgoingServerPort": 123,
  "OutgoingServerSSL": true,
  "OutgoingServerUsername": "<string>",
  "ReplyToEmail": "<string>",
  "LastCheckTime": "<string>",
  "LastMessageId": 123,
  "ErrorCount": 123,
  "GoogleAccessToken": "<string>",
  "Office365AccessToken": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200