Retrieve a list of all managed users

Get list of managed users

Endpoints

get /api/v1/mdm/users

Copy full URL

Request URL

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

Scope

MDMUser.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/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

searchstringOptional

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

user_identifierstringOptional

includestringOptional

Comma-separated list of related fields to include in the response (e.g., assigned_to, payload_details). When omitted, only top-level fields are returned

select_allbooleanOptional

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

user_typestringOptional

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

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomain/api/v1/mdm/users?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&search=SOME_STRING_VALUE&user_identifier=SOME_STRING_VALUE&include=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&user_type=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/users?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&search=SOME_STRING_VALUE&user_identifier=SOME_STRING_VALUE&include=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&user_type=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/users?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&search=SOME_STRING_VALUE&user_identifier=SOME_STRING_VALUE&include=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&user_type=SOME_STRING_VALUE", headers=headers)

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

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


    parameters = "search=value" + "&" + "user_identifier=value" + "&" + "include=value" + "&" + "select_all=value" + "&" + "user_type=value";

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

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/users" + "?" + 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/users?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&search=SOME_STRING_VALUE&user_identifier=SOME_STRING_VALUE&include=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&user_type=SOME_STRING_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

usersJSON Array

Array of managed user objects

Show Sub-Attributes

JSON Object

Show Sub-Attributes

user_emailstring

Email address of the user

user_idstring

Unique identifier of the user

user_namestring

Name of the managed user

phone_numberstring

Phone number of the managed user

domain_namestring

Domain of the user

device_countinteger

Number of devices currently assigned to this user

metadataJSON Object

Metadata about the result set including total record count

Show Sub-Attributes

total_record_countstring

Total number of user records matching the query

pagingJSON Object

Pagination links for navigating result pages

Show Sub-Attributes

nextstring

URL for the next page of results, or null if this is the last page

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

List of managed users with pagination

Copied!

  {
    "metadata": {
      "total_record_count": "2"
    },
    "paging": {
      "next": "https://appDomain/api/v1/mdm/users?skip-token=NDo1OjE6MTU2ODcyMzM5NjUwOQ%3D%3D"
    },
    "users": [
      {
        "user_email": "email_address@zylker.com",
        "domain_name": "mdm",
        "user_id": "9007199254740999",
        "user_name": "admin",
        "phone_number": "+1-555-0****99",
        "device_count": 0
      },
      {
        "user_email": "john.doe@zylker.com",
        "domain_name": "mdm",
        "user_id": "9007199254741000",
        "user_name": "Zylker User",
        "phone_number": "+1-555-****12",
        "device_count": 2
      }
    ]
  }

▼ Show full

No managed users found

Copied!

  {
    "metadata": {
      "total_record_count": "0"
    },
    "paging": {},
    "users": []
  }

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