Retrieve a list of all created announcements

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get the Announcement details list

Endpoints

Request URL

https://{server-hostname}:8383/api/v1/mdm/announcements

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

limitintegerOptional

Maximum number of records to return in a single response. Used together with offset for pagination

skip-tokenstringOptional

Pagination continuation token returned by a previous response. Pass it to fetch the next page of results

offsetintegerOptional

Zero-based index of the first record to return. Used together with limit for pagination

delta-tokenstringOptional

Token used for delta/incremental fetches. Pass the token returned from a previous response to retrieve only items modified since that point

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/announcements?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
announcementJSON Array

Array of announcement objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
announcement_idlong

Unique ID representing the announcement

announcement_namestring

Name/title of the announcement

announcement_formatinteger

Display format code determining how the announcement is rendered on device

creation_timestring

Epoch timestamp (milliseconds) when the announcement was created

last_modified_timestring

Epoch timestamp (milliseconds) when the announcement was last modified

created_by_userstring

Username of the admin who created the announcement

last_modified_by_userstring

Username of the admin who last modified the announcement

collection_idstring

Internal collection ID associated with this announcement

profile_idstring

Internal profile ID associated with this announcement

ack_buttonstring

Acknowledgement button text shown on device. Empty string if acknowledgement not required

needs_acknowledgementboolean

Whether the announcement requires acknowledgement from the device user

is_moved_to_trashboolean

Whether the announcement has been soft-deleted (moved to trash)

announcement_detailJSON Object

Nested object containing announcement message content details

Show Sub-Attributes
titlestring

Title of the announcement

title_colorstring

Hex color code for the title text (e.g., #ffffff)

nbar_iconstring

Path to the notification bar icon image

nbar_messagestring

Short message displayed in the device notification bar

detail_messagestring

Full HTML message content displayed in the app

announcement_img_idstring

Image ID for the notification bar image

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

List of all announcements with metadata and detail content

Copied!
  {
    "announcement": [
      {
        "creation_time": "1603910052300",
        "last_modified_time": "1603910052252",
        "announcement_name": "test1",
        "announcement_format": 1,
        "needs_acknowledgement": false,
        "last_modified_by_user": "admin",
        "created_by_user": "admin",
        "collection_id": "9007199254741137",
        "ack_button": "",
        "is_moved_to_trash": false,
        "profile_id": "9007199254740995",
        "announcement_id": 9007199254740996,
        "announcement_detail": {
          "nbar_message": "",
          "title_color": "#ffffff",
          "nbar_icon": "/images/announcement/nbaricon/info.png",
          "announcement_img_id": "9007199254740995",
          "detail_message": "Sample announcement message content",
          "title": "test1"
        }
      }
    ]
  }
                
Show full

No announcements found

Copied!
  {
    "announcement": []
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.