Search Apple App Store applications

GET

/v1/organizations/:organizationId/mdm/apple/enterprise/applications/search

Search Apple App Store applications

Required Permission: mdm.apple.application.search

Searches for applications in the Apple App Store and returns matching results with metadata.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Unique identifier for organization managing Apple enterprise application deployments and configurations.

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

text string

optional

Search query string for matching applications by name or keyword in Apple App Store.

≤ 256 characters

country string

optional

ISO 3166-1 alpha-2 country code for region-specific App Store search and availability.

≤ 2 characters

os string

optional

Target operating system platform filter restricting search to iOS or macOS applications.

iosmacos

kind string

optional

Content type filter for restricting search results to applications or books.

bookapp

Responses

200 Response application/json

status boolean optional

data object optional

resultCount integer optional

Total number of matching applications found in App Store search results.

≥ 0

results array [object] optional

Array of application metadata objects matching search criteria from Apple App Store.

appStoreId integer optional

Apple App Store numeric application identifier for unique identification in iTunes and enterprise catalogs.

≥ 0

bundleId string optional

Apple bundle identifier uniquely identifying application across App Store and enterprise deployments.

≤ 256 characters

name string optional

Human-readable application name displayed in device app lists and enterprise catalogs.

≤ 256 characters

description string optional

Detailed application description providing feature overview and purpose for users and administrators.

icon string optional

URL or path to application icon image displayed in enterprise catalog and device interfaces.

≤ 256 characters

version string optional

Current application version string displayed in App Store listings and device metadata.

≤ 256 characters

minimumOsVersion string optional

Minimum operating system version required for application installation and compatibility validation.

≤ 256 characters

artistName string optional

Developer or publisher name displayed in App Store listings and application metadata.

≤ 256 characters

artistId integer optional

Apple developer account numeric identifier linking application to publisher in App Store.

≥ 0

size integer optional

Application binary size in bytes indicating storage requirements for device deployment.

≥ 0

formattedPrice string optional

Human-readable price string including currency symbol for App Store purchase display.

≤ 256 characters

price integer optional

Numeric application price in local currency for App Store purchase and budgeting.

≥ 0

currency string optional

ISO 4217 currency code for application pricing in regional App Store.

≤ 256 characters

contentAdvisoryRating string optional

Age-based content rating indicating appropriate audience and content restrictions for application.

≤ 256 characters

kind string optional

Application or book content type classification for App Store categorization and filtering.

≤ 256 characters

{
    "status": true,
    "data": {
        "resultCount": 25,
        "results": [
            {
                "appStoreId": 1234567890,
                "bundleId": "com.example.myapp",
                "name": "My Enterprise App"
            }
        ]
    }
}

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"
    }
}