 API: Announcements
Announcements in any status. The default listing is unexpired only; All=1 includes expired announcements.
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/announce/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single announcement ID. Returned even if the announcement has expired. |
All |
Optional. 1 = list every announcement including expired ones (default is unexpired only). |
StartDate |
Optional. Only announcements created on or after this date (yyyy-mm-dd). |
EndDate |
Optional. Only announcements created on or before this date (yyyy-mm-dd). |
Response Properties
| Property | Description |
id |
Announcement ID (number) |
headline |
Headline (string) |
text |
Announcement body, may contain HTML (string) |
status |
Status: 0 = Pending, 1 = Offline, 2 = Online (number) |
expires |
Expiration date (string) |
created |
Posted date/time (string, yyyy-mm-dd HH:mm:ss) |
createdBy |
Posting member's name (string) |
modified |
Last modified date/time; empty if never modified (string) |
modifiedBy |
Modifying member's name; empty if never modified (string) |
Sample Request
GET https://www.YourDepartment.com/apps/api/announce/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "announce",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 17,
"items": [
{
"id": 214,
"headline": "Station 2 Bay Doors Closed for Repairs",
"text": "The Station 2 bay doors will be closed Tuesday, September 8 for repairs. Use the rear entrance.",
"status": 2,
"expires": "2026-09-30 00:00:00",
"created": "2026-09-01 18:22:00",
"createdBy": "John Smith",
"modified": "2026-09-02 07:45:00",
"modifiedBy": "Mary Jones"
}
]
}
Records are returned in the items array. count is the
number of records in this response; totalCount is all matching records regardless of paging. Page with
StartRow and MaxRows (default 100, maximum 1000) until count + startRow exceeds totalCount.
Back to the API Documentation
|
September 21, 2026: