BusinessAnnouncements
Search BusinessAnnouncements
Search and list BusinessAnnouncement records with filtering, sorting, and pagination.
GET
Search BusinessAnnouncements
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
Filters
Filter by iD of the location where this announcement is published; a network location makes it available to locations in that network..
Filter by whether this announcement is marked active; the current active-announcement query uses ActiveFrom and ActiveTo rather than this flag..
Filter by whether this announcement is configured to send a push notification; scheduling is currently driven by ActiveFrom on create or update..
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..
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..
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..
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
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.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.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.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.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of BusinessAnnouncement records matching the query. See the Get one BusinessAnnouncement endpoint for the full list of properties returned for each record.
Example Response