Skip to main content
GET
/
api
/
content
/
newslettersubscribers
/
{id}
Get one NewsLetterSubscriber
curl --request GET \
  --url https://spaces.nexudus.com/api/content/newslettersubscribers/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "Name": "<string>",
  "CompanyName": "<string>",
  "Language": 123,
  "Email": "<string>",
  "VisitReason": "<string>",
  "Active": true,
  "Viewed": true,
  "Clicked": true,
  "Groups": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the NewsLetterSubscriber record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
Name
string
The name value for this news letter subscriber.
​
CompanyName
string
The company name value for this news letter subscriber.
​
Language
integer
The language value for this news letter subscriber. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.
​
Email
string
The email value for this news letter subscriber.
​
VisitReason
string
The visit reason value for this news letter subscriber.
​
Active
boolean
Whether this news letter subscriber is currently active.
​
Viewed
boolean
Whether viewed is enabled.
​
Clicked
boolean
Whether clicked is enabled.
​
Groups
integer[]
List of groups linked to this record.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "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": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "NewsLetterSubscriber Example",
  "LocalizationDetails": null,
  "CustomFields": null
}