Favicon

You are here: Home > API Reference > Apple > Apple Enrollment Tokens > List Apple enrollment tokens

GET /organizations/:organizationId/mdm/apple/enterprise/enrollment-tokens

Required Permission: mdm.apple.enrollmentToken.list

Retrieves a paginated list of Apple device enrollment tokens configured for the organization.

GET
https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-tokens 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-tokens" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/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/apple/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
Page number for pagination navigation through enrollment token results.
limit integer
optional
Maximum number of enrollment token 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))?$
mdm-user string
optional
Filter enrollment tokens by MDM user identifier for user-specific token listing.
Match pattern: ^[a-fA-F0-9]{24}$
adm-policy string
optional
Filter enrollment tokens by policy identifier for policy-specific token listing.
Match pattern: ^[a-fA-F0-9]{24}$
show-deleted boolean
optional
Flag enabling inclusion of deleted enrollment tokens in search results for audit purposes.

Responses

200 Response application/json
status boolean optional
data object optional
items array [object] optional
id string optional
Unique identifier for Apple enrollment token credentials within organizational MDM deployment system.
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Unique identifier for organization managing Apple enrollment tokens and device registration workflows.
Match pattern: ^[a-fA-F0-9]{24}$
admEnterprise string optional
Apple Device Management enterprise identifier linking enrollment token to MDM server configuration.
Match pattern: ^[a-fA-F0-9]{24}$
admDevice string optional
Apple device identifier for enrollment token once device completes registration using token credentials.
Match pattern: ^[a-fA-F0-9]{24}$
mdmUser object optional
MDM user information associating enrollment token with specific user for device ownership tracking.
displayName string optional
Human-readable enrollment token name for identification and organization in administrative interfaces.
≤ 128 characters
tags array [string] optional
Classification tags for organizing and filtering enrollment tokens by department, device type, or purpose.
state string optional
Enrollment token lifecycle status indicating availability, usage, expiration, or deletion state.
PENDING DONE DELETED EXPIRED
config object optional
Token configuration object containing device setup parameters and enrollment-specific settings.
enroll object optional
Enrollment metadata containing token expiration and configuration signing status for device registration.
type string optional
Enrollment token type classification defining registration method or device ownership model.
≤ 128 characters
subType string optional
Enrollment token subtype providing additional categorization for specialized registration workflows.
≤ 128 characters
updatedAt string optional
Timestamp indicating when enrollment token configuration was last modified or synchronized.
Format: date-time
createdAt string optional
Timestamp indicating when enrollment token credentials were initially generated in system.
Format: date-time
expireAt string optional
Timestamp defining enrollment token expiration deadline after which registration attempts will fail.
Format: date-time
enrollmentLink string optional
Direct URL for device enrollment combining token credentials and configuration for simplified registration workflow.
≤ 500 characters
enrollCode string optional
Short alphanumeric enrollment code for manual token entry during device setup process.
≤ 128 characters
admPolicy object optional
Apple Device Management policy configuration object defining device restrictions and security settings.
admPolicyAssignments array [object] optional
Array of policy assignments with priority ordering applied to devices enrolled using this token.
admVppLocation object optional
Volume Purchase Program location metadata for automatic app assignment during device enrollment.
summary object optional
Summary information providing quick access to enrollment token key metrics and expiration details.
profiles array [object] optional
Array of configuration profiles automatically installed on devices during enrollment using this token.
applications array [object] optional
Array of application assignments automatically deployed to devices during enrollment using this token.
sendEmail boolean optional
Flag enabling automatic enrollment notification email delivery to user with token credentials and instructions.
emailText string optional
Custom message text appended to enrollment notification email providing additional context or instructions.
configuration object optional
Enrollment configuration settings controlling device setup workflow behavior and user data collection.
segmentId integer optional
Segment identifier for scoping enrollment token into an specific segment
≥ 0
totalDocs integer optional
limit integer optional
hasPrevPage boolean optional
hasNextPage boolean optional
page integer optional
totalPages integer optional
prevPage integer optional
nextPage integer optional
lean boolean optional 
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "698f3bde457fafa13d088791",
                "organization": "698f3bde457fafa13d088791",
                "admEnterprise": "698f3bde457fafa13d088791",
                "admDevice": "698f3bde457fafa13d088791",
                "mdmUser": {
                    "id": "698f3bde457fafa13d088791",
                    "email": "[email protected]"
                },
                "displayName": "John Doe - iPhone 15 Pro",
                "tags": [
                    "sales",
                    "executive",
                    "iphone"
                ],
                "state": "PENDING",
                "config": {},
                "enroll": {
                    "serverExpirationDate": "2026-03-15T23: 59:59Z",
                    "mobileConfigSigned": true
                },
                "type": "user",
                "subType": "standard",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "expireAt": "2026-02-20T10: 30:00Z",
                "enrollmentLink": "https://app.applivery.com/enroll/apple/ABC123DEF456",
                "enrollCode": "ABC123DEF",
                "admPolicy": null,
                "admPolicyAssignments": [
                    {
                        "admPolicyId": "698f3bde457fafa13d088791",
                        "admPolicy": {},
                        "priority": 10
                    }
                ],
                "admVppLocation": {
                    "id": "698f3bde457fafa13d088791",
                    "name": "US Corporate VPP",
                    "config": {
                        "countryISO2ACode": "US",
                        "defaultPlatform": "ios",
                        "locationName": "US Corporate Location"
                    }
                },
                "summary": {
                    "expirationTimestamp": "2026-02-20T10: 30:00Z"
                },
                "profiles": [
                    {
                        "id": "string",
                        "organization": "string",
                        "admEnterprise": "string",
                        "admPolicy": "string",
                        "targetType": "device",
                        "name": "string",
                        "config": {},
                        "certificates": [
                            {
                                "mdmAssetId": "string",
                                "format": {
                                    "uuid": "uuid",
                                    "base64": "base64"
                                },
                                "location": "string",
                                "password": "string",
                                "allowAllAppsAccess": true,
                                "keyIsExtractable": true
                            }
                        ],
                        "type": "attached",
                        "UUID": "string",
                        "version": 0,
                        "updatedAt": "2024-01-01T00: 00:00Z",
                        "createdAt": "2024-01-01T00: 00:00Z",
                        "assignedTo": {
                            "policies": [
                                {
                                    "id": "string",
                                    "name": "string"
                                }
                            ],
                            "devices": [
                                {
                                    "id": "string",
                                    "displayName": "string"
                                }
                            ]
                        },
                        "useCustomFileVaultCertificates": true,
                        "parentAdmProfileId": "string"
                    }
                ],
                "applications": [
                    {
                        "admApplication": "698f42e5457fafa13d088794",
                        "managed": true,
                        "managementFlags": 5,
                        "vpp": true,
                        "iOSApp": true,
                        "configuration": {},
                        "action": "forceInstall",
                        "actionStatus": "forceInstall",
                        "scripts": {},
                        "updatePolicy": {}
                    }
                ],
                "sendEmail": true,
                "emailText": "Please enroll your device by following the instructions in this email.",
                "configuration": {
                    "skipPersonalInfo": true
                },
                "segmentId": "1"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}
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"
    }
}