Retrieve a list of all MDM profiles

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get the profile detail list

Endpoints

Request URL

https://{serverurl}/api/v1/mdm/profiles

Scope

MDMOnDemand.MDMDeviceMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- 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

trashedbooleanOptional

When true, includes items that are in trash along with active items. Default: false

trash_onlybooleanOptional

When true, returns only items currently in trash. When false, excludes trashed items. Default: false

searchstringOptional

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

platformstringOptional

Filter results by device platform. Allowed values: 1 or ios, 2 or android, 3 or windows, 4=macOS, 5 or chrome, 6=tvOS. Supports comma-separated multiple values

profile_status_idlongOptional

Filter profiles by status ID. Allowed values: 1=Draft, 2=Published, 3=Archived

summarybooleanOptional

When true, returns only a lightweight summary projection of the resource instead of full details. Default: false

modernmanagementbooleanOptional

When true, returns only modern-management (MDM) profiles. When false, returns legacy/agent-based profiles. Default: false

createdormodifiedbymebooleanOptional

When true, returns only resources created or last modified by the authenticated user. Default: false

config_idsstringOptional

Comma-separated list of configuration IDs to filter the response by

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
profilesJSON array

Array of profile objects

Show Sub-Attributes
JSON object
Show Sub-Attributes
profile_idlong

Unique identifier for the profile

profile_namestring

Name of the profile

profile_descriptionstring

Description of the profile

platform_typeinteger

Profile platform type: 1 - iOS, 2 - Android, 3 - Windows, 4 - Chrome, 5 - MAC and 6 - Apple TV

scopeinteger

Scope of the profile. Android: 0 - devices, 1 - knox container. Chrome: 0 - devices, 2 - user

profile_versioninteger

Current version of the profile

profile_statusstring

Status of the profile (e.g., Yet To Deploy)

profile_status_idinteger

Status ID for the profile: 1 - Yet to Deploy, 110 - Published

collection_idlong

Collection ID of the profile

payloadsarray

List of payload type names in the profile

creation_timelong

Creation timestamp in milliseconds since epoch

last_modified_timelong

Last modified timestamp in milliseconds since epoch

created_bylong

User ID of the user who created the profile

last_modified_bylong

User ID of the user who last modified the profile

is_moved_to_trashboolean

Whether the profile has been moved to trash

Possible HTTP Status Codes

200HTTP code

Sample Response: HTTP 200

List of all configured profiles with metadata

Copied!
  {
    "profiles": [
      {
        "creation_time": 12312321312312,
        "last_modified_time": 213123213123,
        "profile_version": 1,
        "payloads": [
          "restrictionspolicy",
          "passcodepolicy"
        ],
        "last_modified_by": 213900719925474100000,
        "profile_description": "Test IOS Restrictions Policy",
        "created_by": 21321312312,
        "collection_id": 2132131231241,
        "profile_name": "IOS Restrictions Policy",
        "profile_status": "Yet To Deploy",
        "platform_type": 1,
        "is_moved_to_trash": false,
        "profile_id": 12321312312,
        "scope": 0,
        "profile_status_id": 1
      }
    ]
  }
                
Show full

No profiles found

Copied!
  {
    "profiles": []
  }
                
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.