Favicon

You are here: Home > API Reference > Apple > Apple Commands > List commands grouped by type

List commands grouped by type

Required Permission: mdm.apple.command.list

Retrieves commands for the specified target, grouped by command type for consolidated viewing.

GET
/v1/organizations/:organizationId/mdm/apple/enterprise/commands/:targetType/:targetId/grouped
Copy to clipboard

List commands grouped by type

Required Permission: mdm.apple.command.list

Retrieves commands for the specified target, grouped by command type for consolidated viewing.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Organization identifier or slug used in path parameters for scoping API operations to specific organizational contexts.
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
targetType string
required
Command target classification specifying whether operation applies to device or device user affecting scope and available command types.
devicedeviceUser
targetId string
required
Identifier for the command target supporting device ID, serial number, IMEI, or user identifier enabling flexible targeting.
Match pattern: ^(([a-fA-F0-9]{24})|(\w{1,}))$
page integer
optional
Page number for paginated results enabling navigation through large command group datasets with consistent result sizes.
limit integer
optional
Maximum number of grouped command records per page controlling response payload size and client-side rendering performance.
groupName string
optional
Logical grouping identifier categorizing related commands together for consolidated display and operational organization within management interfaces.
≤ 128 characters
types array
optional
Array of command group types for filtering operations enabling retrieval of multiple related command categories simultaneously.
type string
optional
Command group classification organizing operations by logical category such as sync, refresh, authentication, or manual execution.
refreshsyncauthenticatemanualsyncRefreshtokendeviceRemovedreinstallMobileConfigupdateCertificatedeclarativefixpreSync

Responses

200 Response application/json
status boolean optional
data object optional
items array [object] optional
groupName string optional
Logical grouping identifier categorizing related commands together for consolidated display and operational organization within management interfaces.
≤ 128 characters
lastDate string optional
Timestamp of the most recent command within this group enabling chronological sorting and activity monitoring.
Format: date-time
commands array [object] optional
Array of command records belonging to this group organized together for consolidated display and operational review.
id string optional
Unique identifier for the command record enabling tracking of individual Apple device management operations across their full execution lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Reference to the organization owning this command providing organizational context and access control boundaries for device management operations.
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Reference to the Apple Enterprise configuration under which this command executes linking operations to Apple MDM protocol resources.
Match pattern: ^[a-fA-F0-9]{24}$
targetType string optional
Command target classification specifying whether operation applies to device or device user affecting scope and available command types.
device deviceUser
targetId string optional
Identifier for the command target supporting device ID, serial number, IMEI, or user identifier enabling flexible targeting.
Match pattern: ^[a-fA-F0-9]{24}$
mdmUser string optional
Reference to the mobile device user associated with the target enabling user-specific command tracking and attribution for auditing.
Match pattern: ^[a-fA-F0-9]{24}$
UUID string optional
Apple MDM protocol command UUID uniquely identifying this operation within device-MDM server communication enabling correlation with Apple responses.
≤ 128 characters
status string optional
Current execution state indicating whether command is pending, acknowledged, completed, or encountered errors affecting subsequent action availability.
Pending Awaiting Error CommandFormatError Acknowledged Tried Cancel Superseded ProtectionCanceled
command object optional
Apple MDM protocol command payload object containing operation-specific parameters and instructions sent to target device.
from string optional
Command origin indicator specifying trigger source such as configuration change, sync operation, or manual execution.
force configurationChanged unknown sync refresh creation installApplication unInstallApplication deviceUpdated deviceUserUpdated profileUpdated applicationUpdated policyUpdated buildUpdated managedConfigurationChanged
data object optional
Additional command context data including device response, error information, or operation-specific metadata for troubleshooting.
sentAt string optional
Timestamp when command was transmitted to Apple Push Notification service for delivery to target device.
Format: date-time
receivedAt string optional
Timestamp when device acknowledged receipt of command indicating successful delivery through APNs infrastructure.
Format: date-time
triedAt string optional
Timestamp of most recent command execution attempt enabling retry tracking and failure pattern analysis for troubleshooting.
Format: date-time
canceledAt string optional
Timestamp when command was canceled by administrator or system preventing further execution attempts and marking operation as terminated.
Format: date-time
numTries integer optional
Counter tracking execution attempt count enabling retry limit enforcement and reliability monitoring for command delivery.
≥ 0
groupName string optional
Logical grouping identifier categorizing related commands together for consolidated display and operational organization within management interfaces.
≤ 128 characters
info object optional
Contextual metadata object containing references to related entities such as builds, assets, apps, profiles, or error details.
build any optional
createdAt string optional
Timestamp marking command creation establishing audit trail foundation and enabling time-based filtering for operational analysis.
Format: date-time
updatedAt string optional
Timestamp recording the most recent command state modification enabling change tracking and execution progress monitoring.
Format: date-time
totalDocs integer optional
limit integer optional
hasPrevPage boolean optional
hasNextPage boolean optional
page integer optional
totalPages integer optional
prevPage integer optional
nextPage integer optional
lean boolean optional 
{
    "status": true,
    "data": {
        "items": [
            {
                "groupName": "DeviceInformation",
                "lastDate": "2026-02-10T14: 30:00Z",
                "commands": [
                    {
                        "id": "507f1f77bcf86cd799439011",
                        "status": "Acknowledged",
                        "createdAt": "2026-02-10T12: 00:00Z"
                    }
                ]
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}