Favicon

You are here: Home > API Reference > Android > Enrollmenttokens > List Android enrollment tokens

List Android enrollment tokens

Required Permission: mdm.android.enrollmentToken.list

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

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-tokens 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-tokens" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-tokens", {
  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-tokens",
    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
Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.
limit integer
optional
Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size.
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))?$
mdm-user string
optional
MDM user identifier filter for retrieving enrollment tokens assigned to specific user account in organization.
Match pattern: ^[a-fA-F0-9]{24}$
status array
optional
List of enrollment token lifecycle states for filtering results by availability, completion, or expiration status.

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Unique enrollment token identifier used to track Android Enterprise device enrollment credentials throughout lifecycle.
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Organization identifier owning this enrollment token and managing enrolled Android Enterprise devices under EMM policy.
Match pattern: ^[a-fA-F0-9]{24}$
emmEnterprise string optional
Android Enterprise (EMM) enterprise account identifier linked to Google Managed Play for device and app management.
Match pattern: ^[a-fA-F0-9]{24}$
emmPolicyAssignments array [object] optional
Ordered list of Android Enterprise policy assignments applied to devices enrolling with this token prioritized by sequence.
mdmUser object optional
MDM user account information associated with enrollment token including identifier and email for device ownership tracking.
emmDevice string optional
Android Enterprise device identifier created after successful enrollment using this token for device lifecycle tracking.
Match pattern: ^[a-fA-F0-9]{24}$
displayName any optional
Human-readable enrollment token name displayed in dashboard for administrative identification and organizational purposes throughout device lifecycle.
tags array optional
Custom classification labels for enrollment token organization enabling filtering, grouping, and policy automation across device fleet.
status string optional
Current enrollment token lifecycle state indicating availability for device enrollment or completion status tracking.
PENDING DONE DELETED EXPIRED
sendEmail any optional
Flag controlling whether enrollment instructions and QR code are automatically sent to MDM user email address.
managementMode string optional
Android Enterprise management mode defining device ownership and control level applied during enrollment process execution.
DEVICE_OWNER PROFILE_OWNER COPE USERLESS
emailText any optional
Custom message content appended to enrollment notification email for user-specific instructions or organizational policy communication.
config object optional
Technical enrollment configuration containing Google Cloud generated credentials and expiration settings for device provisioning.
_config any optional
Internal configuration data restricted to administrator access level containing sensitive enrollment credentials and system metadata.
summary object optional
Enrollment token overview containing human-readable management mode description and expiration information for dashboard display.
type string optional
Enrollment token type classifier indicating platform-specific enrollment method used for cross-platform MDM management dashboards.
≤ 128 characters
subType string optional
Enrollment token sub-classification providing additional context for specialized enrollment scenarios within Android Enterprise management.
≤ 128 characters
state string optional
Legacy enrollment token state field maintained for backward compatibility with previous API versions tracking lifecycle.
PENDING DONE DELETED EXPIRED
perpetual any optional
Flag indicating whether enrollment token has unlimited validity or follows standard expiration policy for continuous enrollment.
qrcodeUrl string optional
URL to downloadable QR code image embeddin enrollment credentials for Android device camera-based provisioning workflow.
enrollmentLink string optional
Deep link URL for Android enrollment initiation allowing web-based device provisioning without QR code scanning.
≤ 256 characters
createdAt string optional
ISO timestamp when enrollment token was created in system for audit tracking and lifecycle management purposes.
updatedAt string optional
ISO timestamp of last enrollment token modification for change tracking and synchronization across distributed systems.
segmentId integer optional
Segment identifier for scoping enrollment token 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",
                "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
            }
        ],
        "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"
    }
}