Retrieve a list of all apps in the App Repository

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 app list from repository

Endpoints

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

platformstringOptional

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

ispaidappbooleanOptional
isbusinessappbooleanOptional
isenterpriseappbooleanOptional
businessstore_idlongOptional

Unique identifier of the Business Store (Apple VPP / Managed Google Play / Microsoft Store) to scope the request to

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/apps?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&search=SOME_STRING_VALUE&platform=SOME_STRING_VALUE&ispaidapp=SOME_BOOLEAN_VALUE&isbusinessapp=SOME_BOOLEAN_VALUE&isenterpriseapp=SOME_BOOLEAN_VALUE&businessstore_id=SOME_INTEGER_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
appsJSON Array

Array of app objects in the App Repository

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_idlong

Unique identifier for the app in the MDM repository

app_namestring

Name of the app

app_categorystring

Category of the app (e.g., Education, Productivity)

app_typeinteger

App type: 0 = Free Store App, 1 = Paid Store App, 2 = Enterprise App

versionstring

Version of the app

platform_typeinteger

Platform: 1 = iOS, 2 = Android, 3 = Windows

descriptionstring

Custom description of the app

iconstring

URL link for the app icon image. May be null if no icon is set

added_timelong

Epoch timestamp (milliseconds) when the app was added to the MDM server

modified_timelong

Epoch timestamp (milliseconds) when the app was last modified

release_labelsJSON Array

Array of release label objects with version details for this app

Show Sub-Attributes
JSON Object
Show Sub-Attributes
release_label_typeinteger

Version type: 1 = Stable, 2 = Beta

release_label_namestring

Label name (e.g., Stable, Beta)

release_label_idlong

Unique ID for the release label

app_versionstring

The version of the app in this label

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

List of apps in the repository with release label version details

Copied!
  {
    "apps": [
      {
        "app_name": "Zylker MDM",
        "app_type": 2,
        "added_time": 1714630800000,
        "modified_time": 1714717200000,
        "platform_type": 2,
        "icon": "https://appDomain/mdm-logo.png",
        "description": "The is an enterprise app",
        "app_category": "Education",
        "app_id": 9007199254741080,
        "version": "1.1.1",
        "release_labels": [
          {
            "release_label_type": 1,
            "app_version": "12.3.45",
            "release_label_name": "Stable",
            "release_label_id": 9007199254741076
          }
        ]
      }
    ]
  }
                
Show full

No apps found in the repository

Copied!
  {
    "apps": []
  }
                
Show full

Duration: 1 minute | Threshold: 60 | 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.