Search BusinessAnnouncements

GET

api

content

businessannouncements

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

import requests

url = "https://spaces.nexudus.com/api/content/businessannouncements"

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

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

A BusinessAnnouncement is a location announcement shown to customers in the Members Portal and app, with optional plain-text content, image, and call-to-action button. Its public availability is scheduled by UTC ActiveFrom and ActiveTo values.

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location where this announcement is published; a network location makes it available to locations in that network..

string

Filter by display value for Business.Name..

string

Filter by required title displayed with the announcement..

boolean

Filter by whether this announcement is marked active; the current active-announcement query uses ActiveFrom and ActiveTo rather than this flag..

string

Filter by current image file name.

string

Filter by uRL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).

boolean

Filter by set to true to remove the current image file.

string

Filter by plain-text announcement body; HTML formatting is not supported..

boolean

Filter by whether to display the optional call-to-action button with this announcement..

string

Filter by text displayed on the call-to-action button when ShowButton is enabled..

string

Filter by destination URL for the call-to-action button when ShowButton is enabled..

boolean

Filter by whether this announcement is configured to send a push notification; scheduling is currently driven by ActiveFrom on create or update..

string

Filter by text configured for the announcement’s push notification..

string

Filter by uTC publish-from date and time; the active query requires this value to be strictly earlier than the current UTC time, and create or update schedules its push job at this time..

string

Filter by optional UTC publish-until date and time; an announcement remains active only while this value is strictly later than the current UTC time..

boolean

Filter by whether the announcement is marked for contacts, meaning customers without an active contract; the current active-announcement query does not apply this audience flag..

boolean

Filter by whether the announcement is marked for members, meaning customers with an active contract; the current active-announcement query does not apply this audience flag..

Range Filters

string

Filter by uTC publish-from date and time; the active query requires this value to be strictly earlier than the current UTC time, and create or update schedules its push job at this time. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC publish-from date and time; the active query requires this value to be strictly earlier than the current UTC time, and create or update schedules its push job at this time. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC publish-until date and time; an announcement remains active only while this value is strictly later than the current UTC time. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC publish-until date and time; an announcement remains active only while this value is strictly later than the current UTC time. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

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

string

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

string

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

string

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

Code Examples

Simple listing

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

const response = await fetch(
  'https://spaces.nexudus.com/api/content/businessannouncements?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/businessannouncements',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/content/businessannouncements?' + new URLSearchParams({
    BusinessAnnouncement_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/businessannouncements',
    params={
        'BusinessAnnouncement_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/content/businessannouncements?' + new URLSearchParams({
    from_BusinessAnnouncement_UpdatedOn: '2025-01-01T00:00',
    to_BusinessAnnouncement_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/businessannouncements',
    params={
        'from_BusinessAnnouncement_UpdatedOn': '2025-01-01T00:00',
        'to_BusinessAnnouncement_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

BusinessAnnouncement[]

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

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "Active": false,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "Body": null,
      "ShowButton": false,
      "ButtonLabel": null,
      "ButtonUrl": null,
      "SendPushNotification": false,
      "PushNotificationText": null,
      "ActiveFrom": null,
      "ActiveTo": null,
      "OnlyForContacts": false,
      "OnlyForMembers": 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": "BusinessAnnouncement 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
}

Search BusinessAnnouncements

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

import requests

url = "https://spaces.nexudus.com/api/content/businessannouncements"

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

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200