Get
/GetActiveSystemAnnouncements
Allows you to retreive active system announcements.
Security
API Key: api_key
Header parameter nameapi_key
Query parameters
organizationId
integer (int64)
The ID of the organization for which you would like to retrieve system announcements
Example4536
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
Results
Array of object (Announcement)
See Announcement.
object
Id
integer (int32)
The announcement's unique identifier
Example45632
Title
string
The announcement's title
ExampleSample Announcement
Url
string | null
The Url which the announcement is meant to link to.
Example
Description
string | null
The announcement's description
ExampleThis is an example Announcement
HtmlContent
string | null
The announcement's HTML Content
Example<h1>This is an important Announcement!</h1><p>This is the content of the announcement.</p>
Start
integer (int64)
When the announcement starts (in Unix epoch time)
Example1449496800
End
integer (int64) | null
When the announcement starts (in Unix epoch time)
Example1450479600