Favicon

You are here: Home > API Reference > Android > Emmenrollmenttemplates > List Android enrollment templates

List Android enrollment templates

Required Permission: mdm.android.enrollmentTemplate.list

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

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-templates 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-templates" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-templates", {
  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/enrollment-templates",
    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 navigation through enrollment template results.
limit integer
optional
Maximum number of enrollment template records returned per page.
sort string
optional
Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.
Match pattern: ^[\w.]*((:asc)|(:desc))?$
name string
optional
Human-readable enrollment template name identifying configuration purpose for Android device onboarding workflows.
≤ 128 characters
defaultZeroTouchConfiguration any
optional
Flag designating template as default configuration for Android zero-touch enrollment automatic device provisioning.
defaultManagedDomain any
optional
Flag designating template as default configuration for managed Google domain enrollment workflows.
managementMode string
optional
Android Enterprise management mode specifying device ownership and profile configuration for enrolled devices.
DEVICE_OWNERPROFILE_OWNERCOPEUSERLESS
segmentId integer
optional
Segment identifier for scoping smart enrollment into an specific segment
expandTo string
optional
Param to include ancestor or child related entities
ancestorschildren

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Unique identifier for Android enrollment template configuration within organizational EMM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
name string required
Human-readable enrollment template name identifying configuration purpose for Android device onboarding workflows.
≤ 128 characters
description any optional
Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
emmEnrollmentTokenId string optional
Android Enterprise enrollment token identifier linking template to Google Play managed configuration.
Match pattern: ^[a-fA-F0-9]{24}$
emmEnrollmentToken object optional
emmPolicyId string optional
Android Enterprise policy identifier defining device restrictions and security settings for enrollment.
Match pattern: ^[a-fA-F0-9]{24}$
emmPolicy object optional
rules array [object] optional
Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
version string optional
Sequential version string tracking enrollment template configuration changes and synchronization state.
≤ 128 characters
updatedAt string optional
Timestamp indicating when enrollment template configuration was last modified or synchronized.
createdAt string optional
Timestamp indicating when enrollment template configuration was initially created in system.
devicesCount integer optional
Total number of Android devices currently enrolled and managed using this enrollment template.
≥ 0 · ≤ 9007199254740991
defaultZeroTouchConfiguration any optional
Flag designating template as default configuration for Android zero-touch enrollment automatic device provisioning.
defaultManagedDomain any optional
Flag designating template as default configuration for managed Google domain enrollment workflows.
auxiliaryFields array [object] optional
Array of custom input fields collected from users during enrollment for conditional policy application.
signinDetail object optional
loginProviderTypes array [string] optional
Array of authentication provider types permitted for user verification during device enrollment workflow.
allowAutoContinue any optional
Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
managementMode string optional
Android Enterprise management mode specifying device ownership and profile configuration for enrolled devices.
DEVICE_OWNER PROFILE_OWNER COPE USERLESS
segmentId integer optional
Segment identifier for scoping smart enrollment into an specific segment
≥ 0 · ≤ 9007199254740991
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",
                "emmEnrollmentTokenId": "string",
                "emmEnrollmentToken": {
                    "id": "string",
                    "organization": "string",
                    "emmEnterprise": "string",
                    "emmPolicyAssignments": [
                        {
                            "emmPolicyId": "string",
                            "emmPolicy": "string",
                            "priority": 0
                        }
                    ],
                    "mdmUser": {
                        "id": "string",
                        "email": "string"
                    },
                    "emmDevice": "string",
                    "displayName": "string",
                    "tags": [
                        "string"
                    ],
                    "status": "PENDING",
                    "sendEmail": true,
                    "managementMode": "DEVICE_OWNER",
                    "emailText": "string",
                    "config": {
                        "expirationTimestamp": "string",
                        "code": "string"
                    },
                    "_config": "string",
                    "summary": {
                        "managementMode": "DEVICE_OWNER",
                        "expirationTimestamp": "string"
                    },
                    "type": "string",
                    "subType": "string",
                    "state": "PENDING",
                    "perpetual": true,
                    "qrcodeUrl": "string",
                    "enrollmentLink": "string",
                    "createdAt": "string",
                    "updatedAt": "string",
                    "segmentId": 0
                },
                "emmPolicyId": "string",
                "emmPolicy": {
                    "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
                },
                "rules": [
                    {
                        "name": "string",
                        "displayNamePattern": "string",
                        "tags": [
                            "string"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "string"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "string"
                                    ]
                                ],
                                "patterns": [
                                    "string"
                                ],
                                "identifiers": [
                                    "string"
                                ]
                            }
                        ],
                        "emmPolicyId": "string",
                        "emmPolicyAssignments": [
                            {
                                "emmPolicyId": "string",
                                "priority": 0
                            }
                        ],
                        "segmentId": 0
                    }
                ],
                "version": "string",
                "updatedAt": "string",
                "createdAt": "string",
                "devicesCount": 0,
                "defaultZeroTouchConfiguration": true,
                "defaultManagedDomain": true,
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "string",
                        "title": "string",
                        "description": "string",
                        "options": [
                            "string"
                        ]
                    }
                ],
                "signinDetail": {
                    "signinUrl": "string",
                    "signinEnrollmentToken": "string",
                    "qrCode": "string",
                    "allowPersonalUsage": "ALLOW_PERSONAL_USAGE_UNSPECIFIED",
                    "defaultStatus": "SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED",
                    "enrollmentLink": "string"
                },
                "loginProviderTypes": [
                    "ldap"
                ],
                "allowAutoContinue": true,
                "managementMode": "DEVICE_OWNER",
                "segmentId": 0
            }
        ],
        "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"
    }
}