Search NewsLetterSubscribers

Search and list NewsLetterSubscriber records with filtering, sorting, and pagination.

GET /api/content/newslettersubscribers

Search NewsLetterSubscribers

cURL

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

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A NewsLetterSubscriber represents a person subscribed to receive newsletters. Subscribers can be customers, leads, or external contacts and have a preferred language for communications.

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 NewsLetterSubscriber-List role.

Enums

eLanguage — Language values

Value	Name
3	EnglishUK
1	EnglishUS
2	Spanish

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

NewsLetterSubscriber_Business · integer

Filter by iD of the business linked to this record.

NewsLetterSubscriber_Name · string

Filter by the name value for this news letter subscriber.

NewsLetterSubscriber_CompanyName · string

Filter by the company name value for this news letter subscriber.

NewsLetterSubscriber_Language · integer

Filter by the language value for this news letter subscriber.

NewsLetterSubscriber_Email · string

Filter by the email value for this news letter subscriber.

NewsLetterSubscriber_VisitReason · string

Filter by the visit reason value for this news letter subscriber.

NewsLetterSubscriber_Active · boolean

Filter by whether this news letter subscriber is currently active.

NewsLetterSubscriber_Viewed · boolean

Filter by whether viewed is enabled.

NewsLetterSubscriber_Clicked · boolean

Filter by whether clicked is enabled.

Range Filters

from_NewsLetterSubscriber_CreatedOn · string

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

to_NewsLetterSubscriber_CreatedOn · string

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

from_NewsLetterSubscriber_UpdatedOn · string

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

to_NewsLetterSubscriber_UpdatedOn · string

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

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/content/newslettersubscribers?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/content/newslettersubscribers?NewsLetterSubscriber_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

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

Response

200

Records · NewsLetterSubscriber[]

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

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,
      "Name": "",
      "CompanyName": null,
      "Language": 0,
      "Email": "",
      "VisitReason": null,
      "Active": false,
      "Viewed": false,
      "Clicked": false,
      "Groups": [],
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "NewsLetterSubscriber Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}