Retrieve the list of groups an announcement is distributed to

Get the individual Announcement distributed to groups

Endpoints

get /api/v1/mdm/announcements/{announcement_id}/groups

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

announcement_idstringMandatory

Unique identifier of the announcement. Obtain from the Create Announcement or Get Announcements response

- 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/{announcement_id}/groups?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'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/announcements/{announcement_id}/groups?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")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/api/v1/mdm/announcements/{announcement_id}/groups?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/announcements/{announcement_id}/groups"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/announcements/{announcement_id}/groups?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

metadataJSON Object

Pagination metadata with total record count

Show Sub-Attributes

total_record_countstring

Total number of user records matching the query

groupsJSON Array

Array of group objects the announcement is distributed to

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_idstring

Unique identifier of the group

namestring

Display name of the group

group_typestring

Type code of the group (e.g., 6 for device group)

member_countstring

Number of members in the group

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

List of groups the announcement is distributed to with metadata

Copied!

  {
    "metadata": {
      "total_record_count": "2"
    },
    "groups": [
      {
        "group_id": "9007199254741899",
        "name": "Device group 1",
        "group_type": "6",
        "member_count": "0"
      },
      {
        "group_id": "9007199254741901",
        "name": "Device group 2",
        "group_type": "6",
        "member_count": "2"
      }
    ]
  }

▼ Show full

Announcement is not distributed to any groups

Copied!

  {
    "metadata": {
      "total_record_count": "0"
    },
    "groups": []
  }

▼ 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.