List Apple enrollment templates

GET

https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-templates

curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/enterprise/enrollment-templates" \
  -H "Authorization: Bearer <YOUR_API_KEY>"

const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/apple/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/apple/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 device onboarding workflows.

≤ 128 characters

segmentId integer

optional

expandTo string

optional

ancestorschildren

Responses

200 Response application/json

status boolean optional

data object optional

items array [object] optional

id string optional

Unique identifier for Apple enrollment template configuration within organizational MDM deployment.

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.

≤ 128 characters

description string optional

Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.

≤ 256 characters

rules array [object] optional

Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.

auxiliaryFields array [object] optional

Array of custom input fields collected from users during enrollment for conditional policy application.

loginProviderTypes array [string] optional

Array of authentication provider types permitted for user verification during device enrollment workflow.

allowAutoContinue boolean optional

Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.

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.

Format: date-time

createdAt string optional

Timestamp indicating when enrollment template configuration was initially created in system.

Format: date-time

devicesCount integer optional

Total number of Apple devices currently enrolled and managed using this enrollment template.

≥ 0

segmentId integer optional

Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Pro
    
       Responses
    
    
      
      
      
        
          200 Response
          application/json
        
      
      
        
          
          
        
        
          
        
          status
          boolean
          
          optional
          
        
        
      

        
          
          data
          object
          
          optional
          
        
        
        
          
        
          
          items
          array [object]
          
          optional
          
        
        
        
          
        
          id
          string
          
          optional
          
        
        Unique identifier for Apple enrollment template configuration within organizational MDM deployment.
Match pattern: ^[a-fA-F0-9]{24}$
      

        
          name
          string
          
          optional
          
        
        Human-readable enrollment template name identifying configuration purpose for device onboarding workflows.
≤ 128 characters
      

        
          description
          string
          
          optional
          
        
        Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.
≤ 256 characters
      

        
          
          rules
          array [object]
          
          optional
          
        
        Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.
        
          
        
      

        
          
          auxiliaryFields
          array [object]
          
          optional
          
        
        Array of custom input fields collected from users during enrollment for conditional policy application.
        
          
        
      

        
          loginProviderTypes
          array [string]
          
          optional
          
        
        Array of authentication provider types permitted for user verification during device enrollment workflow.
      

        
          allowAutoContinue
          boolean
          
          optional
          
        
        Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.
      

        
          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.
Format: date-time
      

        
          createdAt
          string
          
          optional
          
        
        Timestamp indicating when enrollment template configuration was initially created in system.
Format: date-time
      

        
          devicesCount
          integer
          
          optional
          
        
        Total number of Apple devices currently enrolled and managed using this enrollment template.
≥ 0
      

        
          segmentId
          integer
          
          optional
          
        
        Segment identifier for scoping smart enrollment 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": "698f2b1c18f11470ce02da32",
                "name": "Sales Team iPad Enrollment",
                "description": "Standard configuration for sales team iPads with productivity apps and security policies.",
                "rules": [
                    {
                        "name": "Executive Device Setup",
                        "displayNamePattern": "{firstName}-{lastName}-iPad",
                        "setDeviceName": true,
                        "tags": [
                            "executive",
                            "high-security"
                        ],
                        "conditions": [
                            {
                                "tags": [
                                    [
                                        "executive"
                                    ],
                                    [
                                        "manager",
                                        "director"
                                    ]
                                ],
                                "auxiliaryFields": [
                                    [
                                        "department:sales"
                                    ],
                                    [
                                        "location:hq"
                                    ]
                                ],
                                "patterns": [
                                    "^iPad.*",
                                    ".*Proquot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}
          
        
      
    
    
  quot;
                                ],
                                "identifiers": [
                                    "[email protected]",
                                    "A1B2C3D4E5F6"
                                ]
                            }
                        ],
                        "admPolicyId": "698f2b1c18f11470ce02da32",
                        "admPolicyAssignments": [
                            {
                                "admPolicyId": "698f2b1c18f11470ce02da32",
                                "admPolicy": {},
                                "priority": 10
                            }
                        ],
                        "commands": [
                            {
                                "type": "InstallProfile",
                                "profileId": "698f2b1c18f11470ce02da32"
                            }
                        ],
                        "admVppLocationId": "698f2b1c18f11470ce02da32",
                        "admVppLocationInfo": {
                            "id": "698f2b1c18f11470ce02da32",
                            "name": "US Corporate VPP",
                            "config": {
                                "countryISO2ACode": "US",
                                "defaultPlatform": "ios",
                                "locationName": "US Corporate Location"
                            }
                        },
                        "allowActivationLock": false,
                        "setupAssistantEnable": true,
                        "setupAssistantSkippable": false,
                        "skipPersonalInfo": true,
                        "segmentId": 1
                    }
                ],
                "auxiliaryFields": [
                    {
                        "type": "select",
                        "key": "department",
                        "title": "Department",
                        "description": "Select your organizational department for policy assignment.",
                        "options": [
                            "Sales",
                            "Engineering",
                            "Marketing",
                            "Operations"
                        ]
                    }
                ],
                "loginProviderTypes": [
                    "ldap",
                    "saml",
                    "google"
                ],
                "allowAutoContinue": true,
                "version": "3.2.1",
                "updatedAt": "2026-02-10T14: 22:00Z",
                "createdAt": "2026-01-15T10: 30:00Z",
                "devicesCount": 45,
                "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"
    }
}

Request

Authorization

Path Params1

Query Params6

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses

Responses