Skip to main content
GET
/
api
/
content
/
businessannouncements
{
  "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 notification displayed to customers on the members portal and mobile app. Announcements support plain text only (no bold, italics, or lists) and can include an optional image and a call-to-action button. Use ActiveFrom and ActiveTo to schedule when the announcement is visible. Use OnlyForContacts and OnlyForMembers to control the audience:
OnlyForContactsOnlyForMembersAudience
falsefalseAll customers (contacts and members)
truefalseContacts only (no active contract)
falsetrueMembers only (with an active contract)
Announcement images should ideally be 600x350 pixels (12:7 aspect ratio). Set NewImageUrl to a URL to upload a new image, or set ClearImage to true to remove the current image.

​
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

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
BusinessAnnouncement_Business
integer
Filter by Business Id.
​
BusinessAnnouncement_Business_Name
string
Filter by business name.
​
BusinessAnnouncement_Name
string
Filter by announcement title.
​
BusinessAnnouncement_Active
boolean
Filter by whether the announcement is active and visible to customers.
​
BusinessAnnouncement_ImageFileName
string
Filter by current image file name.
​
BusinessAnnouncement_NewImageUrl
string
Filter by uRL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).
​
BusinessAnnouncement_ClearImage
boolean
Filter by Clear Image File.
​
BusinessAnnouncement_Body
string
Filter by announcement body text (plain text only, no formatting).
​
BusinessAnnouncement_ShowButton
boolean
Filter by whether to display a call-to-action button in the announcement.
​
BusinessAnnouncement_ButtonLabel
string
Filter by text displayed on the call-to-action button.
​
BusinessAnnouncement_ButtonUrl
string
Filter by uRL the call-to-action button redirects to (must start with https://).
​
BusinessAnnouncement_SendPushNotification
boolean
Filter by whether to send a push notification to customers when the announcement is published.
​
BusinessAnnouncement_PushNotificationText
string
Filter by text of the push notification sent to customers.
​
BusinessAnnouncement_ActiveFrom
string
Filter by date from which the announcement is visible to customers (publish from).
​
BusinessAnnouncement_ActiveTo
string
Filter by date until which the announcement is visible to customers (publish to).
​
BusinessAnnouncement_OnlyForContacts
boolean
Filter by restrict announcement visibility to contacts (customers without an active contract).
​
BusinessAnnouncement_OnlyForMembers
boolean
Filter by restrict announcement visibility to members (customers with an active contract).

​
Range Filters

​
from_BusinessAnnouncement_ActiveFrom
string
Filter by date from which the announcement is visible to customers (publish from) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessAnnouncement_ActiveFrom
string
Filter by date from which the announcement is visible to customers (publish from) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_BusinessAnnouncement_ActiveTo
string
Filter by date until which the announcement is visible to customers (publish to) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessAnnouncement_ActiveTo
string
Filter by date until which the announcement is visible to customers (publish to) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_BusinessAnnouncement_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessAnnouncement_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_BusinessAnnouncement_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_BusinessAnnouncement_UpdatedOn
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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

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

​
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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
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.
Partial records — The listing endpoint returns a summary representation of each BusinessAnnouncement. The following fields are not included in the Records[] response: Body, OnlyForContacts, OnlyForMembers.To get all fields, fetch the full record using the Get one BusinessAnnouncement endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
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
}