Search EmailQueueItems - Nexudus Platform

GET

api

sys

emailqueueitems

Search EmailQueueItems

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/emailqueueitems \
  --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 EmailQueueItem represents a single email queued for delivery. Each record tracks the sender, recipient, subject, body, and delivery status of an outgoing email message.

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

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

EmailQueueItem_Business

integer

Filter by iD of the business linked to this record.

EmailQueueItem_EmailAccount

integer

Filter by iD of the email account linked to this record.

EmailQueueItem_FromUser

integer

Filter by iD of the from user linked to this record.

EmailQueueItem_Header

string

Filter by the header value for this email queue item.

EmailQueueItem_Body

string

Filter by the body value for this email queue item.

EmailQueueItem_FromEmail

string

Filter by the from email value for this email queue item.

EmailQueueItem_ToEmails

string

Filter by the to emails value for this email queue item.

EmailQueueItem_CCEmails

string

Filter by the cc emails value for this email queue item.

EmailQueueItem_CCOEmails

string

Filter by the cco emails value for this email queue item.

EmailQueueItem_Sent

boolean

Filter by whether sent is enabled.

EmailQueueItem_SentAttempts

integer

Filter by the sent attempts value for this email queue item.

EmailQueueItem_Delivered

boolean

Filter by whether delivered is enabled.

EmailQueueItem_LastSendError

string

Filter by the last send error value for this email queue item.

EmailQueueItem_SendDate

string

Filter by date/time value for send date.

EmailQueueItem_Queued

boolean

Filter by whether queued is enabled.

EmailQueueItem_FromName

string

Filter by the from name value for this email queue item.

Range Filters

from_EmailQueueItem_SentAttempts

integer

Filter by the sent attempts value for this email queue item greater than or equal to this value.

to_EmailQueueItem_SentAttempts

integer

Filter by the sent attempts value for this email queue item less than or equal to this value.

from_EmailQueueItem_SendDate

string

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

to_EmailQueueItem_SendDate

string

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

from_EmailQueueItem_CreatedOn

string

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

to_EmailQueueItem_CreatedOn

string

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

from_EmailQueueItem_UpdatedOn

string

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

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

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"

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"

Response

200

Records

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.

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

Get one EmailQueueItemRetrieve a single EmailQueueItem record by its Id.

Search EmailQueueItems

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/emailqueueitems \
  --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

​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