Search EmailQueueItems

GET

api

sys

emailqueueitems

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

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

fetch('https://spaces.nexudus.com/api/sys/emailqueueitems', 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 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-List role.

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 location that owns this queued email..

integer

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

integer

Filter by optional ID of the staff user recorded as the sender of this email..

string

Filter by email subject line, limited to 1,024 characters..

string

Filter by localized HTML content sent as the email body..

string

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

string

Filter by required recipient email addresses, separated with semicolons..

string

Filter by optional carbon-copy recipient email addresses, separated with semicolons..

string

Filter by optional blind-carbon-copy recipient email addresses, separated with semicolons..

boolean

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

integer

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

boolean

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

string

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

string

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

boolean

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

string

Filter by optional sender display name that overrides the selected email account or location email settings..

Range Filters

integer

Filter by number of send attempts made by the email delivery process; retrying through the queue command resets it to zero. greater than or equal to this value.

integer

Filter by number of send attempts made by the email delivery process; retrying through the queue command resets it to zero. less than or equal to this value.

string

Filter by uTC date and time when the system last completed a send attempt; empty until an attempt is made. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC date and time when the system last completed a send attempt; empty until an attempt is made. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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/sys/emailqueueitems?page=1&size=15&orderBy=ToEmails&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by ToEmails

curl -X GET \
  "https://spaces.nexudus.com/api/sys/emailqueueitems?EmailQueueItem_ToEmails=example-value&orderBy=ToEmails&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/emailqueueitems',
    params={
        'EmailQueueItem_ToEmails': 'example-value',
        'orderBy': 'ToEmails',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/emailqueueitems?' + new URLSearchParams({
    from_EmailQueueItem_UpdatedOn: '2025-01-01T00:00',
    to_EmailQueueItem_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/sys/emailqueueitems',
    params={
        'from_EmailQueueItem_UpdatedOn': '2025-01-01T00:00',
        'to_EmailQueueItem_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

EmailQueueItem[]

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

Partial records — The listing endpoint returns a summary representation of each EmailQueueItem. The following fields are not populated in the Records[] response: Body, FromEmail, CCEmails, CCOEmails, SentAttempts, LastSendError, FromName.To get all fields, fetch the full record using the Get one EmailQueueItem 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,
      "EmailAccountId": null,
      "FromUserId": null,
      "Header": null,
      "ToEmails": "",
      "Sent": false,
      "Delivered": false,
      "SendDate": null,
      "Queued": false,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "ToEmails",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search EmailQueueItems

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

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

fetch('https://spaces.nexudus.com/api/sys/emailqueueitems', 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

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by ToEmails

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by ToEmails

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by ToEmails

Range filters

Response

200