Get one EmailQueueItem

GET

api

sys

emailqueueitems

{id}

Get one EmailQueueItem

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

import requests

url = "https://spaces.nexudus.com/api/sys/emailqueueitems/{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/sys/emailqueueitems/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "EmailAccountId": 123,
  "FromUserId": 123,
  "Header": "<string>",
  "Body": "<string>",
  "FromEmail": "<string>",
  "ToEmails": "<string>",
  "CCEmails": "<string>",
  "CCOEmails": "<string>",
  "Sent": true,
  "SentAttempts": 123,
  "Delivered": true,
  "LastSendError": "<string>",
  "SendDate": "<string>",
  "Queued": true,
  "FromName": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An EmailQueueItem is a read-only outgoing email delivery record for a location, tracking its recipients, content, sender, attempts, and delivery result.

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

Path Parameters

integer

required

The Id of the EmailQueueItem record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the location that owns this queued email..

integer

Optional ID of the email account whose outgoing server and sender details are used instead of the location’s default email settings..

integer

Optional ID of the staff user recorded as the sender of this email..

string

Email subject line, limited to 1,024 characters..

string

Localized HTML content sent as the email body..

string

Optional reply-to email address; when empty, the selected email account or location email settings provide it..

string

Required recipient email addresses, separated with semicolons..

string

Optional carbon-copy recipient email addresses, separated with semicolons..

string

Optional blind-carbon-copy recipient email addresses, separated with semicolons..

boolean

Whether the system has completed a send attempt; this can be true even when Delivered is false..

integer

Number of send attempts made by the email delivery process; retrying through the queue command resets it to zero..

boolean

Whether the most recent send attempt was accepted successfully by the email delivery process..

string

Most recently recorded delivery error, including provider-reported bounces; empty when no error is currently recorded..

string

UTC date and time when the system last completed a send attempt; empty until an attempt is made..

boolean

Internal queue-processing flag managed by the email delivery system and retry command..

string

Optional sender display name that overrides the selected email account or location email settings..

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,
  "EmailAccountId": null,
  "FromUserId": null,
  "Header": null,
  "Body": null,
  "FromEmail": null,
  "ToEmails": "",
  "CCEmails": null,
  "CCOEmails": null,
  "Sent": false,
  "SentAttempts": 0,
  "Delivered": false,
  "LastSendError": null,
  "SendDate": null,
  "Queued": false,
  "FromName": 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": "EmailQueueItem Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one EmailQueueItem

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

import requests

url = "https://spaces.nexudus.com/api/sys/emailqueueitems/{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/sys/emailqueueitems/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "EmailAccountId": 123,
  "FromUserId": 123,
  "Header": "<string>",
  "Body": "<string>",
  "FromEmail": "<string>",
  "ToEmails": "<string>",
  "CCEmails": "<string>",
  "CCOEmails": "<string>",
  "Sent": true,
  "SentAttempts": 123,
  "Delivered": true,
  "LastSendError": "<string>",
  "SendDate": "<string>",
  "Queued": true,
  "FromName": "<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