Search EmailQueueItems

GET

api

sys

emailqueueitems

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

import requests

url = "https://spaces.nexudus.com/api/sys/emailqueueitems"

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', 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 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

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 business linked to this record.

integer

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

integer

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

string

Filter by the header value for this email queue item.

string

Filter by the body value for this email queue item.

string

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

string

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

string

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

string

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

boolean

Filter by whether sent is enabled.

integer

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

boolean

Filter by whether delivered is enabled.

string

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

string

Filter by date/time value for send date.

boolean

Filter by whether queued is enabled.

string

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

Range Filters

integer

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

integer

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

string

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

string

Filter by date/time value for send date 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
}

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>'

import requests

url = "https://spaces.nexudus.com/api/sys/emailqueueitems"

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', 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