<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "apple-school-and-business-manager-api",
  "identifier" : "/documentation/AppleSchoolManagerAPI",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service",
  "symbol" : {
    "kind" : "Web Service",
    "modules" : [
      "Apple School Manager API"
    ],
    "preciseIdentifier" : "AppleSchoolManagerAPI"
  },
  "title" : "Apple School Manager API"
}
-->

# Apple School Manager API

Automate device management activities and view device information in Apple School Manager.

## Overview> Note: This API is a part of the <doc://com.apple.apple-school-and-business-manager-api/documentation/apple-school-and-business-manager-api> collection.

## Topics

### Authentication

  <doc:implementing-oauth-for-the-apple-school-and-business-manager-api>

### Devices

[`Get Organization Devices`](/documentation/AppleSchoolManagerAPI/Get-Org-Devices)

Get a list of devices in an organization that enroll using Automated Device Enrollment.

[`Get Device Information`](/documentation/AppleSchoolManagerAPI/Get-OrgDevice-Information)

Get information about a device in an organization.

[`Get AppleCare Coverage Information for a Device`](/documentation/AppleSchoolManagerAPI/Get-All-AppleCare-coverage-for-an-OrgDevice)

Get a list of AppleCare coverage resources for an organization device.

### Device Management Services

[`Get Device Management Services`](/documentation/AppleSchoolManagerAPI/Get-Device-Management-Services)

Get a list of device management services in an organization.

[`Get Device Management Service Information`](/documentation/AppleSchoolManagerAPI/Get-MdmServer-Information)

Get the information for a specific device management service.

[`Get All Device IDs for a Device Management Service`](/documentation/AppleSchoolManagerAPI/Get-All-Device-IDs-for-a-Device-Management-Service)

[`Get the Assigned Device Management Service ID for a Device`](/documentation/AppleSchoolManagerAPI/Get-the-Assigned-Device-Management-Service-ID-for-an-OrgDevice)

Get the assigned device management service ID information for a device.

[`Get the Assigned Device Management Service Information for a Device`](/documentation/AppleSchoolManagerAPI/Get-the-Assigned-Device-Management-Service-Information-for-an-OrgDevice)

Get the assigned device management service information for a device.

[`Assign or Unassign Devices to a Device Management Service`](/documentation/AppleSchoolManagerAPI/Create-an-OrgDeviceActivity)

Assign or unassign devices to a device management service, or manage a device management service for devices.

[`Get Organization Device Activity Information`](/documentation/AppleSchoolManagerAPI/Get-OrgDeviceActivity-Information)

Get information for an organization device activity that a device management action, such as assigning or unassigning, creates.

### Objects and Data Types

[`object OrgDevice`](/documentation/AppleSchoolManagerAPI/OrgDevice)

The data structure that represents an organization device resource.

[`object OrgDeviceResponse`](/documentation/AppleSchoolManagerAPI/OrgDeviceResponse)

A response that contains a single organization device resource.

[`object OrgDevicesResponse`](/documentation/AppleSchoolManagerAPI/OrgDevicesResponse)

A response that contains a list of organization device resources.

[`object OrgDeviceAssignedServerLinkageResponse`](/documentation/AppleSchoolManagerAPI/OrgDeviceAssignedServerLinkageResponse)

The data and links that describe the relationship between the resources.

[`object MdmServer`](/documentation/AppleSchoolManagerAPI/MdmServer)

The data structure that represents device management services in organizations.

[`object MdmServerResponse`](/documentation/AppleSchoolManagerAPI/MdmServerResponse)

A response that contains a single device management service resource.

[`object MdmServersResponse`](/documentation/AppleSchoolManagerAPI/MdmServersResponse)

A response that contains a list of device management service resources.

[`object MdmServerDevicesLinkagesResponse`](/documentation/AppleSchoolManagerAPI/MdmServerDevicesLinkagesResponse)

The data and links that describe the relationship between the resources.

[`object OrgDeviceActivity`](/documentation/AppleSchoolManagerAPI/OrgDeviceActivity)

The data structure that represents an organization device activity resource.

[`object OrgDeviceActivityCreateRequest`](/documentation/AppleSchoolManagerAPI/OrgDeviceActivityCreateRequest)

The request body you use to update the device management service for a device.

[`object OrgDeviceActivityResponse`](/documentation/AppleSchoolManagerAPI/OrgDeviceActivityResponse)

A response that contains a single organization device activity resource.

[`object AppleCareCoverage`](/documentation/AppleSchoolManagerAPI/AppleCareCoverage)

The data structure that represents an AppleCare coverage resource that belongs to an organization device.

[`object AppleCareCoverageResponse`](/documentation/AppleSchoolManagerAPI/AppleCareCoverageResponse)

A response that contains a list of AppleCare coverage resources that belongs to an organization device.

[`object PagedDocumentLinks`](/documentation/AppleSchoolManagerAPI/PagedDocumentLinks)

Links related to the response document, including paging links.

[`object PagingInformation`](/documentation/AppleSchoolManagerAPI/PagingInformation)

Paging information for data responses.

[`object RelationshipLinks`](/documentation/AppleSchoolManagerAPI/RelationshipLinks)

Links related to the response document, including self-links.

[`object ResourceLinks`](/documentation/AppleSchoolManagerAPI/ResourceLinks)

Self-links to requested resources.

[`object ErrorResponse`](/documentation/AppleSchoolManagerAPI/ErrorResponse)

The error details that an API returns in the response body whenever the API request isn’t successful.

[`object ErrorLinks`](/documentation/AppleSchoolManagerAPI/ErrorLinks)

[`object JsonPointer`](/documentation/AppleSchoolManagerAPI/JsonPointer)

An object that contains the JSON pointer that indicates the location of the error.

[`object Parameter`](/documentation/AppleSchoolManagerAPI/Parameter)

An object that contains the query parameter that produces the error.

[`object DocumentLinks`](/documentation/AppleSchoolManagerAPI/DocumentLinks)

Self-links to documents that can contain information for one or more resources.

### Type Aliases

[`string OrgDeviceActivityType`](/documentation/AppleSchoolManagerAPI/OrgDeviceActivityType)

Strings that represent organization device activities.

[`string AppleCareCoveragePaymentType`](/documentation/AppleSchoolManagerAPI/AppleCareCoveragePaymentType)

Strings that represent AppleCare coverage payment types.

[`string AppleCareCoverageStatus`](/documentation/AppleSchoolManagerAPI/AppleCareCoverageStatus)

Strings that represent AppleCare coverage status.

### Endpoints

[`Get the Activation Lock Status for a Device`](/documentation/AppleSchoolManagerAPI/Get-the-Activation-Lock-Status-Information-for-an-OrgDevice)

Get the Activation Lock status of an organization device.

### Dictionaries

[`object ActivationLockStatus`](/documentation/AppleSchoolManagerAPI/ActivationLockStatus)

The data structure that represents the Activation Lock status of an organization device.

[`object ActivityTypeMetadata`](/documentation/AppleSchoolManagerAPI/ActivityTypeMetadata)

Additional metadata for an organization device activity, used by device management service migration activity types.

### Type Aliases

[`string ActivationLockType`](/documentation/AppleSchoolManagerAPI/ActivationLockType)

Strings that represent the type of Activation Lock on a device.

[`string MdmMigrationStatus`](/documentation/AppleSchoolManagerAPI/MdmMigrationStatus)

Strings that represent the state of a device’s device management service migration.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)