Favicon

You are here: Home > API Reference > UEM > Mdm Users > Retrieve paginated list of MDM users

GET /organizations/:organizationId/mdm/users

Required Permission: mdm.global.mdmUser.list

Retrieve paginated list of device management users within the organization with filtering options for search and tag criteria.

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/users 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/users" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/users", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/users",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Organization identifier or URL-friendly slug for scoping user operations within specific workspace and access control boundaries.
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer
optional
Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.
limit integer
optional
Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size.
sort string
optional
Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.
Match pattern: ^[\w.]*((:asc)|(:desc))?$
search string
optional
Text search query matching against user email, name, or other identifying fields for quick user location and filtering.
≤ 128 characters
email string
optional
Primary contact address for device user utilized for enrollment notifications, account identification, and administrative communications.
≤ 128 characters
name string
optional
Display name for device management user shown in administrative interfaces and reports for identification and personalization purposes.
≤ 128 characters
tags array
optional
Organizational labels assigned to user for categorization, filtering, and grouping in listings and automation rule targeting.

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Unique identifier for device management user enabling targeted operations and tracking across all platform endpoints and administrative interfaces.
Match pattern: ^[a-fA-F0-9]{24}$
email string required
Primary contact address for device user utilized for enrollment notifications, account identification, and administrative communications.
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
name string required
Display name for device management user shown in administrative interfaces and reports for identification and personalization purposes.
≤ 256 characters
tags array required
Organizational labels assigned to user for categorization, filtering, and grouping in listings and automation rule targeting.
android object required
Android platform statistics aggregating device counts and enrollment token status for Android Enterprise management visibility and analytics.
aosp object required
AOSP platform statistics aggregating custom DPC non-GMS Android device counts and enrollment token lifecycle status for backend-managed Android visibility.
apple object required
Apple platform statistics showing enrolled device count and active enrollment profile assignments for iOS, iPadOS, and macOS management.
windows object required
Windows platform statistics displaying enrolled device count and available enrollment tokens for Windows desktop management operations.
language string required
Preferred language code for user controlling interface localization, email communications, and notification content throughout platform.
es en fr de it zh pt ru
managedAppleId string optional
Managed Apple ID email address linked to this user for Apple Business Manager integration and app license distribution.
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
metadata object required
Custom key-value pairs storing additional user information for integration purposes, reporting needs, or organizational specific requirements.
inferredSegmentIds array [number] required
List of segment where the user in included
createdAt string required
ISO 8601 timestamp indicating when user account was initially created providing historical context and analytics for user lifecycle tracking.
updatedAt string required
ISO 8601 timestamp indicating when user record was most recently modified useful for tracking changes, synchronization, and audit trail.
totalDocs integer required
≥ -9007199254740991 · ≤ 9007199254740991
limit integer required
≥ -9007199254740991 · ≤ 9007199254740991
hasPrevPage boolean required
hasNextPage boolean required
page integer required
≥ -9007199254740991 · ≤ 9007199254740991
totalPages integer required
≥ -9007199254740991 · ≤ 9007199254740991
prevPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
nextPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "email": "[email protected]",
                "name": "string",
                "tags": [
                    "string"
                ],
                "android": {
                    "devices": {
                        "MANAGEMENT_MODE_UNSPECIFIED": 0,
                        "DEVICE_OWNER": 0,
                        "PROFILE_OWNER": 0
                    },
                    "enrollmentTokens": {
                        "DONE": 0,
                        "PENDING": 0,
                        "EXPIRED": 0,
                        "DELETED": 0
                    }
                },
                "aosp": {
                    "devices": {
                        "MANAGEMENT_MODE_UNSPECIFIED": 0,
                        "DEVICE_OWNER": 0
                    },
                    "enrollmentTokens": {
                        "DONE": 0,
                        "PENDING": 0,
                        "PROCESSING": 0,
                        "EXPIRED": 0,
                        "DELETED": 0
                    }
                },
                "apple": {
                    "devices": 0,
                    "enrollmentTokens": 0
                },
                "windows": {
                    "devices": 0,
                    "enrollmentTokens": 0
                },
                "language": "es",
                "managedAppleId": "[email protected]",
                "metadata": {},
                "inferredSegmentIds": [
                    0
                ],
                "createdAt": "string",
                "updatedAt": "string"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4001
message string optional
Unauthorized
{
    "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"
    }
}