Get one NewsLetterSubscriber

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

import requests

url = "https://spaces.nexudus.com/api/content/newslettersubscribers/{id}"

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/content/newslettersubscribers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/newslettersubscribers/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/newslettersubscribers/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

The name value for this news letter subscriber.

string

The company name value for this news letter subscriber.

integer

The language value for this news letter subscriber. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.

string

The email value for this news letter subscriber.

string

The visit reason value for this news letter subscriber.

boolean

Whether this news letter subscriber is currently active.

boolean

Whether viewed is enabled.

boolean

Whether clicked is enabled.

integer[]

List of groups linked to this record.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple NewsLetterSubscribersRetrieve multiple NewsLetterSubscriber records by their Ids in a single request.

Get one NewsLetterSubscriber

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

import requests

url = "https://spaces.nexudus.com/api/content/newslettersubscribers/{id}"

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/content/newslettersubscribers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200