Get All Announcements

Gets all announcements in the system.

Resource Information

Scopeannouncements

Deprecated scope name:   get_announcements

App TypeAll
Authorization TypeAccess token
URI /v4/announcements?fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringYes Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
isReadstringNoY | NIndicates whether to return announcements with read or unread messages.7.3.3.4
langStringNo Indicates the language applied.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.3
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3
result.isReadstringIndicates whether or not an announcement has been read by the logged-in user.7.3.3.4
result.startEffectDatedateTimeThe starting effective date.7.3.3
result.textstringThe localized display text.7.3.3
result.titlestringThe individual's business title. 7.3.3
statusintegerThe record status.7.3.3