Favicon

You are here: Home > API Reference > Android > Emmenrollmenttemplates > List direct provisioning items for an enrollment template

List direct provisioning items for an enrollment template

Required Permission: mdm.android.directProvisioning.list

Retrieves a paginated list of direct provisioning items associated with a specific Android Enterprise enrollment template.

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

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))?$

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
emmEnrollmentTemplateId string required
Match pattern: ^[a-fA-F0-9]{24}$
enrollmentTokenId string required
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
mdmUserId string optional
Match pattern: ^[a-fA-F0-9]{24}$
auxiliaryFields array [object] optional
mdmUser object optional
enrollmentToken object required
validRule object optional
createdAt string required
updatedAt string required
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",
                "emmEnrollmentTemplateId": "string",
                "enrollmentTokenId": "string",
                "name": "string",
                "mdmUserId": "string",
                "auxiliaryFields": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ],
                "mdmUser": {
                    "id": "string",
                    "email": "string"
                },
                "enrollmentToken": {
                    "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
                },
                "validRule": {
                    "name": "string",
                    "displayNamePattern": "string",
                    "tags": [
                        "string"
                    ],
                    "conditions": [
                        {
                            "tags": [
                                [
                                    "string"
                                ]
                            ],
                            "auxiliaryFields": [
                                [
                                    "string"
                                ]
                            ],
                            "patterns": [
                                "string"
                            ],
                            "identifiers": [
                                "string"
                            ]
                        }
                    ],
                    "emmPolicyId": "string",
                    "emmPolicyAssignments": [
                        {
                            "emmPolicyId": "string",
                            "priority": 0
                        }
                    ],
                    "segmentId": 0
                },
                "createdAt": "string",
                "updatedAt": "string"
            }
        ],
        "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"
    }
}