Get one SubscriberGroup

GET

api

content

subscribergroups

{id}

Get one SubscriberGroup

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

import requests

url = "https://spaces.nexudus.com/api/content/subscribergroups/{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/subscribergroups/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "NewsLetterSubscribers": [
    123
  ],
  "AutoAddMembers": true,
  "AutoAddContacts": true,
  "AutoAddBookings": true,
  "AutoAddEvents": true,
  "AutoAddVisitors": true,
  "AutoAddPayingMembers": true,
  "Tariffs": [
    123
  ],
  "AutoMembership": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A SubscriberGroup defines a segment or group of newsletter subscribers that can be targeted for specific communications or campaigns.

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 SubscriberGroup-Read role.

Path Parameters

integer

required

The Id of the SubscriberGroup record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Display name of the linked business (read-only).

string

The name value for this subscriber group.

integer[]

List of news letter subscribers linked to this record.

boolean

Whether auto add members is enabled.

boolean

Whether auto add contacts is enabled.

boolean

Whether auto add bookings is enabled.

boolean

Whether auto add events is enabled.

boolean

Whether auto add visitors is enabled.

boolean

Whether auto add paying members is enabled.

integer[]

List of tariffs linked to this record.

boolean

Whether auto membership is enabled.

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,
  "BusinessName": null,
  "Name": "",
  "NewsLetterSubscribers": [],
  "AutoAddMembers": false,
  "AutoAddContacts": false,
  "AutoAddBookings": false,
  "AutoAddEvents": false,
  "AutoAddVisitors": false,
  "AutoAddPayingMembers": false,
  "Tariffs": [],
  "AutoMembership": 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": "SubscriberGroup Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple SubscriberGroupsRetrieve multiple SubscriberGroup records by their Ids in a single request.

Get one SubscriberGroup

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

import requests

url = "https://spaces.nexudus.com/api/content/subscribergroups/{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/subscribergroups/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "NewsLetterSubscribers": [
    123
  ],
  "AutoAddMembers": true,
  "AutoAddContacts": true,
  "AutoAddBookings": true,
  "AutoAddEvents": true,
  "AutoAddVisitors": true,
  "AutoAddPayingMembers": true,
  "Tariffs": [
    123
  ],
  "AutoMembership": true,
  "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