Retrieve detailed information about a specific group

Get a group details

Endpoints

get /api/v1/mdm/groups/{group_id}

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

group_idstringMandatory

Unique identifier of the group. Obtain from the Get Group List response

- Query Parameters

limitintegerOptional

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

skip-tokenstringOptional

offsetintegerOptional

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

delta-tokenstringOptional

includestringOptional

Comma-separated list of related fields to include in the response. Allowed values: summary, member, memberdetails, available. When omitted, only top-level fields are returned

device_group_unassignedbooleanOptional

When true, returns only devices that are not assigned to any device group. Default: false

platform_typestringOptional

Filter results by device platform type. Allowed values: 1=iOS, 2=Android, 3=Windows, 4=macOS, 5=Chrome, 6=tvOS

os_versionstringOptional

Filter results by exact OS version (e.g., 14.0, 12.4.1)

device_typestringOptional

Filter results by device type. Allowed values: 1=Mobile, 2=Tablet, 3=Laptop, 4=Desktop, 5=TV

user_typestringOptional

Filter results by user type. Allowed values: 1=Domain User, 2=Local User, 3=Active Directory User, 4=Azure AD User

group_categorystringOptional

Filter groups by category. Allowed values: 1=Static, 2=Dynamic. Supports comma-separated values

searchstringOptional

Free-text search string applied to the default searchable fields of the resource

select_allbooleanOptional

When true, applies the operation to every record matching the current filter rather than to specific IDs. Default: false

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomain/api/v1/mdm/groups/{group_id}?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&include=SOME_STRING_VALUE&device_group_unassigned=SOME_BOOLEAN_VALUE&platform_type=SOME_STRING_VALUE&os_version=SOME_STRING_VALUE&device_type=SOME_STRING_VALUE&user_type=SOME_STRING_VALUE&group_category=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_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/groups/{group_id}?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&include=SOME_STRING_VALUE&device_group_unassigned=SOME_BOOLEAN_VALUE&platform_type=SOME_STRING_VALUE&os_version=SOME_STRING_VALUE&device_type=SOME_STRING_VALUE&user_type=SOME_STRING_VALUE&group_category=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_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/groups/{group_id}?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&include=SOME_STRING_VALUE&device_group_unassigned=SOME_BOOLEAN_VALUE&platform_type=SOME_STRING_VALUE&os_version=SOME_STRING_VALUE&device_type=SOME_STRING_VALUE&user_type=SOME_STRING_VALUE&group_category=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE", headers=headers)

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

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


    parameters = "skip-token=value" + "&" + "delta-token=value" + "&" + "include=value" + "&" + "device_group_unassigned=value" + "&" + "platform_type=value" + "&" + "os_version=value" + "&" + "device_type=value" + "&" + "user_type=value" + "&" + "group_category=value" + "&" + "search=value" + "&" + "select_all=value";

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

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/groups/{group_id}" + "?" + parameters
        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/groups/{group_id}?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&include=SOME_STRING_VALUE&device_group_unassigned=SOME_BOOLEAN_VALUE&platform_type=SOME_STRING_VALUE&os_version=SOME_STRING_VALUE&device_type=SOME_STRING_VALUE&user_type=SOME_STRING_VALUE&group_category=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

group_idlong

Unique identifier for the group

namestring

Name of the group

group_typeinteger

Type of group: 6 — Device Group

domainstring

Domain in which the group exists

descriptionstring

Description of the group

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Group details for a specific group

Copied!

  {
    "group_id": 99731238129,
    "domain": "ZYLKERCORP",
    "name": "MDM",
    "description": "Group for MDM",
    "group_type": 1
  }

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