Favicon

You are here: Home > API Reference > Android > Policies > List Android device policies

List Android device policies

Required Permission: mdm.android.policy.list

Retrieves a paginated list of Android Enterprise policies configured for the organization.

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/policies 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/policies" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/policies", {
  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/android/enterprise/policies",
    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
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer
optional
Page number for pagination controls starting at one enabling navigation through large policy collections.
limit integer
optional
Maximum number of policies returned per page controlling result set size for pagination efficiency.
sort string
optional
Sort field and direction for ordering policy list results enabling customized data presentation.
Match pattern: ^[\w.]*((:asc)|(:desc))?$
appInfo any
optional
Flag requesting enriched application metadata inclusion in response for detailed app information display.
packages any
optional
Flag requesting package information inclusion in response providing installed application version details.
name string
optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 256 characters
targetType string
optional
Policy application scope defining whether configurations apply to entire device for Android Enterprise management.
device
segmentId integer
optional
Segment identifier for scoping policy into an specific segment
expandTo string
optional
ancestorschildren

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string optional
Unique Android Enterprise policy identifier used to track configuration rules and security settings throughout lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.
≤ 128 characters
description string optional
Detailed policy description explaining configuration purpose business requirements and device restrictions for documentation purposes.
≤ 256 characters
version string optional
Policy version identifier synchronized with Google Android Enterprise policy version for change tracking purposes.
≤ 128 characters
config object optional
Google Android Enterprise policy configuration object containing device restrictions security settings and compliance rules.
_config object optional
Internal configuration data restricted to administrator access level containing sensitive policy credentials and system metadata.
packages object optional
Application package information mapping containing installed app details versions and configuration for reporting purposes.
emmEnterprise string optional
Android Enterprise (EMM) account identifier linked to Google Managed Play for device and application management.
Match pattern: ^[a-fA-F0-9]{24}$
private any optional
Flag indicating whether policy is private to organization or shared across enterprise for template purposes.
assets array [object] optional
List of asset assignments for deploying files certificates configuration data and resources to managed Android devices.
assetsInfo array [object] optional
Enriched asset metadata including file sizes deployment status and version information for monitoring and auditing purposes.
bookmarks array [object] optional
updatedAt string optional
ISO timestamp of last policy modification for change tracking synchronization and audit trail purposes.
createdAt string optional
ISO timestamp when policy was created in system for lifecycle tracking and compliance reporting purposes.
agentConfiguration object optional
MDM agent behavior settings controlling location tracking application monitoring and network status reporting on Android devices.
kioskLauncherConfiguration object optional
Kiosk launcher customization settings defining home screen layout lock screen behavior and application restrictions for dedicated devices.
certificateProviderIds array optional deprecated
Deprecated: Use certificateProviderAssignments instead. List of certificate provider identifiers for deploying PKI credentials and authentication certificates to Android devices.
certificateProviderAssignments array [object] optional
List of certificate provider assignments including credential storage preferences for deploying PKI credentials to Android devices.
applications array [object] required
List of application assignments defining managed apps with installation actions configuration and update policies for deployment.
applicationsInfo array [object] required
Enriched application metadata including app details names icons versions for dashboard display and reporting purposes.
segmentId integer optional
Segment identifier for scoping policy into an specific segment
≥ 0 · ≤ 9007199254740991
exposeToChildren any optional
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",
                "name": "string",
                "description": "string",
                "version": "string",
                "config": {},
                "_config": {},
                "packages": {},
                "emmEnterprise": "string",
                "private": true,
                "assets": [
                    {
                        "mdmAssetId": "string",
                        "location": "string",
                        "assetName": "string",
                        "scope": "user"
                    }
                ],
                "assetsInfo": [
                    {}
                ],
                "bookmarks": [
                    {
                        "title": "string",
                        "description": "string",
                        "url": "https://example.com",
                        "iconBase64": "string",
                        "iconUrl": "string"
                    }
                ],
                "updatedAt": "string",
                "createdAt": "string",
                "agentConfiguration": {
                    "allowLocation": true,
                    "allowPackageTime": true,
                    "allowPackageTransfer": true,
                    "allowNetworkStatus": true,
                    "policyFeatures": {
                        "defaultViewFeature": "bookmarks",
                        "toggledFeatures": [
                            {
                                "name": "bookmarks",
                                "active": true
                            }
                        ],
                        "enableDefaultView": true
                    }
                },
                "kioskLauncherConfiguration": {
                    "displayDeviceName": true,
                    "settingAction": "",
                    "whitelistedApps": [
                        "string"
                    ],
                    "escapeHatchPassword": "string",
                    "backgroundUrl": "string",
                    "iconSize": "small",
                    "screenAlwaysOn": true,
                    "unlockPassword": "string",
                    "inactivityLockTime": 0,
                    "startingUpApps": [
                        {
                            "packageName": "string",
                            "config": {}
                        }
                    ],
                    "appsLayout": [
                        {
                            "type": "app",
                            "package": "string"
                        }
                    ],
                    "header": {
                        "text": "string",
                        "fontSize": "small"
                    },
                    "footer": {
                        "text": "string",
                        "fontSize": "small"
                    }
                },
                "certificateProviderIds": [
                    "string"
                ],
                "certificateProviderAssignments": [
                    {
                        "certificateProviderId": "string",
                        "storeCredentials": true
                    }
                ],
                "applications": [
                    {
                        "emmApplicationId": "string",
                        "configuration": "string",
                        "action": "forceInstall",
                        "updatePolicy": {},
                        "customAppConfig": {}
                    }
                ],
                "applicationsInfo": [
                    {
                        "emmApplicationId": "string",
                        "emmApplication": {
                            "id": "string",
                            "organizationId": "string",
                            "emmEnterpriseId": "string",
                            "type": "build",
                            "config": {
                                "buildId": "string",
                                "applicationId": "string",
                                "mdmAssetId": "string",
                                "filter": "string"
                            },
                            "version": 0,
                            "updatedAt": "string",
                            "createdAt": "string",
                            "origin": "library",
                            "info": {
                                "id": "string",
                                "bundleId": "string",
                                "name": "string",
                                "icon": "string",
                                "processedVersionName": "string",
                                "versionCode": "string",
                                "size": "string",
                                "originalExtension": "string",
                                "applicationInfo": {
                                    "id": "string",
                                    "slug": "string",
                                    "name": "string",
                                    "picture": "string"
                                },
                                "disabled": true,
                                "signatures": [
                                    {
                                        "sha1": "string",
                                        "sha256": "string",
                                        "signatureScheme": "V1"
                                    }
                                ]
                            }
                        }
                    }
                ],
                "segmentId": 0,
                "exposeToChildren": true
            }
        ],
        "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
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"
    }
}