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 newsletter subscriber group (SubscriberGroup) is a location-scoped audience segment for organising newsletter subscribers, either manually or through scheduled rules for members, contacts, attendees, visitors, and booking customers.

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 location that owns this newsletter subscriber group..

string

Display value for Business.Name..

string

Required, unique name used to identify this newsletter subscriber group within the location..

integer[]

List of newsletter subscriber IDs manually assigned to this group; smart-group updates can also add or remove subscribers based on the enabled criteria..

boolean

Whether the smart group automatically includes current members; enabled member criteria are reconciled on the smart-group update cycle..

boolean

Whether the smart group automatically includes current contacts, meaning customers without an active contract..

boolean

Whether the smart group automatically includes customers who have made a booking..

boolean

Whether the smart group automatically includes event attendees..

boolean

Whether the smart group automatically includes visitors to the location..

boolean

Whether the smart group automatically includes team paying members..

integer[]

List of plan IDs used to restrict automatic member inclusion; an empty list means all member plan types, and the list is cleared unless automatic member inclusion or system-managed membership is enabled..

boolean

Whether this is a system-created membership group managed from location settings; read-only groups cannot be edited manually..

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