Gets all announcements in the system.
| Scope | announcements Deprecated scope name: get_announcements |
| App Type | All |
| Authorization Type | Access token |
| URI | /v4/announcements?fields={fields}&lang={lang} |
| HTTP Method | GET |
| Automation Version(s) | 7.3.3 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| fields | string | Yes | � | 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 |
| isRead | string | No | Y | N | Indicates whether to return announcements with read or unread messages. | 7.3.3.4 |
| lang | String | No | � | Indicates the language applied. | 7.3.2 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | � | 7.3.3 |
| result.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3 |
| result.isRead | string | Indicates whether or not an announcement has been read by the logged-in user. | 7.3.3.4 |
| result.startEffectDate | dateTime | The starting effective date. | 7.3.3 |
| result.text | string | The localized display text. | 7.3.3 |
| result.title | string | The individual's business title. | 7.3.3 |
| status | integer | The record status. | 7.3.3 |