<!--
{
  "availability" : [

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

# Apple Business API

Automate device management activities, view device information, and manage users and user groups in Apple Business.

## 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://com.apple.apple-school-and-business-manager-api/documentation/apple-school-and-business-manager-api/implementing-oauth-for-the-apple-school-manager-and-apple-business-api>

### Devices

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

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

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

Get information about a device in an organization.

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

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

[`Get Devices Enrolled in Apple Device Management Service`](/documentation/AppleBusinessAPI/Get-Apple-MDM-Enrolled-Devices)

Get a list of devices enrolled in Apple Device Management service.

[`Get Details for a Device Enrolled in Apple Device Management Service`](/documentation/AppleBusinessAPI/Get-the-Details-for-Apple-MDM-Enrolled-Device)

Get detailed information about a device enrolled in Apple Device Management service.

### Device Management Services

[`Get Device Management Services`](/documentation/AppleBusinessAPI/Get-Mdm-Servers)

Get a list of device management services in an organization.

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

Get the information for a specific device management service.

[`Create a Device Management Service`](/documentation/AppleBusinessAPI/Create-an-MdmServer)

Create a new device management service in an organization.

[`Update a Device Management Service`](/documentation/AppleBusinessAPI/Update-an-MdmServer)

Update an existing device management service in an organization.

[`Delete a Device Management Service`](/documentation/AppleBusinessAPI/Delete-an-MdmServer)

Delete a device management service from an organization.

[`Get the Device Serial Numbers for a Device Management Service`](/documentation/AppleBusinessAPI/Get-All-Device-IDs-for-an-MdmServer)

Get a list of device serial numbers assigned to a device management service.

[`Get the Assigned Device Management Service ID for a Device`](/documentation/AppleBusinessAPI/Get-the-Assigned-Server-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/AppleBusinessAPI/Get-the-Assigned-Server-Information-for-an-OrgDevice)

Get the assigned device management service information for a device.

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

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

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

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

### Users

[`Get Users`](/documentation/AppleBusinessAPI/Get-Users)

Get a list of users in an organization.

[`Get User Information`](/documentation/AppleBusinessAPI/Get-User-Information)

Get information about a specific user in an organization.

### UserGroups

[`Get User Groups`](/documentation/AppleBusinessAPI/Get-User-Groups)

Get a list of user groups in an organization.

[`Get User Group Information`](/documentation/AppleBusinessAPI/Get-UserGroup-Information)

Get information about a specific user group in an organization.

[`Get User IDs for a User Group`](/documentation/AppleBusinessAPI/Get-All-User-IDs-for-a-User-Group)

Get a list of user IDs for a user group in an organization.

### Organizational Units

[`Get Organizational Units`](/documentation/AppleBusinessAPI/Get-Organizational-Units)

Get a list of organizational units in an organization.

[`Get Organizational Unit Information`](/documentation/AppleBusinessAPI/Get-OrganizationalUnit-Information)

Get information about a specific organizational unit in an organization.

[`Get User IDs for an Organizational Unit`](/documentation/AppleBusinessAPI/Get-All-User-IDs-for-an-OrganizationalUnit)

Get a list of user IDs for an organizational unit in an organization.

### Apps and Packages

[`Get Apps`](/documentation/AppleBusinessAPI/Get-Apps)

Get a list of apps for an organization using the built-in device management in Apple Business.

[`Get App Information`](/documentation/AppleBusinessAPI/Get-App-Information)

Get information about a specific app for an organization using the built-in device management in Apple Business.

[`Get Packages`](/documentation/AppleBusinessAPI/Get-Packages)

Get a list of packages for an organization using Apple Business’s built-in device management.

[`Get Package Information`](/documentation/AppleBusinessAPI/Get-Package-Information)

Get information about a specific package for an organization using Apple Business’s built-in device management.

### Blueprints

[`Get Blueprints`](/documentation/AppleBusinessAPI/Get-Blueprints)

Get a list of Blueprints in an organization.

[`Create a Blueprint`](/documentation/AppleBusinessAPI/Create-a-Blueprint)

Create a new Blueprint in an organization.

[`Get Blueprint Information`](/documentation/AppleBusinessAPI/Get-Blueprint-Information)

Get information about a specific Blueprint in an organization.

[`Update a Blueprint`](/documentation/AppleBusinessAPI/Update-a-Blueprint)

Update an existing Blueprint in an organization.

[`Delete a Blueprint`](/documentation/AppleBusinessAPI/Delete-a-Blueprint)

Delete a Blueprint from an organization.

[`Get App IDs for a Blueprint`](/documentation/AppleBusinessAPI/Get-All-App-IDs-for-a-Blueprint)

Get a list of app IDs associated with a Blueprint.

[`Add Apps to a Blueprint`](/documentation/AppleBusinessAPI/Add-Apps-to-a-Blueprint)

Add apps to a Blueprint.

[`Remove Apps from a Blueprint`](/documentation/AppleBusinessAPI/Remove-Apps-from-a-Blueprint)

Remove apps from a Blueprint.

[`Get Configuration IDs for a Blueprint`](/documentation/AppleBusinessAPI/Get-All-Configuration-IDs-for-a-Blueprint)

Get a list of Configuration IDs associated with a Blueprint.

[`Add Configurations to a Blueprint`](/documentation/AppleBusinessAPI/Add-Configurations-to-a-Blueprint)

Add Configurations to a Blueprint.

[`Remove Configurations from a Blueprint`](/documentation/AppleBusinessAPI/Remove-Configurations-from-a-Blueprint)

Remove Configurations from a Blueprint.

[`Get Package IDs for a Blueprint`](/documentation/AppleBusinessAPI/Get-All-Package-IDs-for-a-Blueprint)

Get a list of package IDs associated with a Blueprint.

[`Add Packages to a Blueprint`](/documentation/AppleBusinessAPI/Add-Packages-to-a-Blueprint)

Add packages to a Blueprint.

[`Remove Packages from a Blueprint`](/documentation/AppleBusinessAPI/Remove-Packages-from-a-Blueprint)

Remove packages from a Blueprint.

[`Get Device IDs for a Blueprint`](/documentation/AppleBusinessAPI/Get-All-OrgDevice-IDs-for-a-Blueprint)

Get a list of device IDs associated with a Blueprint.

[`Add Devices to a Blueprint`](/documentation/AppleBusinessAPI/Add-Org-Devices-to-a-Blueprint)

Add devices to a Blueprint.

[`Remove Devices from a Blueprint`](/documentation/AppleBusinessAPI/Remove-Org-Devices-from-a-Blueprint)

Remove devices from a Blueprint.

[`Get User IDs for a Blueprint`](/documentation/AppleBusinessAPI/Get-All-User-IDs-for-a-Blueprint)

Get a list of user IDs associated with a Blueprint.

[`Add Users to a Blueprint`](/documentation/AppleBusinessAPI/Add-Users-to-a-Blueprint)

Add users to a Blueprint.

[`Remove Users from a Blueprint`](/documentation/AppleBusinessAPI/Remove-Users-from-a-Blueprint)

Remove users from a Blueprint.

[`Get User Group IDs for a Blueprint`](/documentation/AppleBusinessAPI/Get-All-User-Group-IDs-for-a-Blueprint)

Get a list of user group IDs associated with a Blueprint.

[`Add User Groups to a Blueprint`](/documentation/AppleBusinessAPI/Add-User-Groups-to-a-Blueprint)

Add user groups to a Blueprint.

[`Remove User Groups from a Blueprint`](/documentation/AppleBusinessAPI/Remove-User-Groups-from-a-Blueprint)

Remove user groups from a Blueprint.

### Configurations

[`Get Configurations`](/documentation/AppleBusinessAPI/Get-Configurations)

Get a list of Configurations in an organization.

[`Create a Configuration`](/documentation/AppleBusinessAPI/Create-a-Configuration)

Create a new custom Configuration in an organization.

[`Get Configuration Information`](/documentation/AppleBusinessAPI/Get-Configuration-Information)

Get information about a specific Configuration in an organization.

[`Update a Configuration`](/documentation/AppleBusinessAPI/Update-a-Configuration)

Update an existing custom Configuration in an organization.

[`Delete a Configuration`](/documentation/AppleBusinessAPI/Delete-a-Configuration)

Delete a Configuration from an organization.

### Audit Events

[`Get Audit Events`](/documentation/AppleBusinessAPI/Get-Audit-Events)

Get a list of audit events in an organization that satisfies the query criteria.

### Objects and Data Types

[`OrgDevice`](/documentation/AppleBusinessAPI/OrgDevice)

The data structure that represents an organization device resource.

[`OrgDeviceResponse`](/documentation/AppleBusinessAPI/OrgDeviceResponse)

A response that contains a single organization device resource.

[`OrgDevicesResponse`](/documentation/AppleBusinessAPI/OrgDevicesResponse)

A response that contains a list of organization device resources.

[`OrgDeviceAssignedServerLinkageResponse`](/documentation/AppleBusinessAPI/OrgDeviceAssignedServerLinkageResponse)

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

[`MdmDevice`](/documentation/AppleBusinessAPI/MdmDevice)

The data structure that represents a device management service enrolled device resource.

[`MdmDeviceResponse`](/documentation/AppleBusinessAPI/MdmDeviceResponse)

A response that contains a list of Apple devices enrolled in a device management service.

[`MdmDevicesResponse`](/documentation/AppleBusinessAPI/MdmDevicesResponse)

A response that contains a list of Apple devices enrolled in a device management service.

[`MdmDeviceDetail`](/documentation/AppleBusinessAPI/MdmDeviceDetail)

The data structure that represents the detailed information for a device management service enrolled device resource.

[`MdmDeviceDetailResponse`](/documentation/AppleBusinessAPI/MdmDeviceDetailResponse)

A response that contains the detailed information for an Apple device enrolled in a device management service.

[`MdmServer`](/documentation/AppleBusinessAPI/MdmServer)

The data structure that represents a device management service resource in an organization.

[`MdmServerResponse`](/documentation/AppleBusinessAPI/MdmServerResponse)

A response that contains a single device management service resource.

[`MdmServersResponse`](/documentation/AppleBusinessAPI/MdmServersResponse)

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

[`MdmServerDevicesLinkagesResponse`](/documentation/AppleBusinessAPI/MdmServerDevicesLinkagesResponse)

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

[`OrgDeviceActivity`](/documentation/AppleBusinessAPI/OrgDeviceActivity)

The data structure that represents an organization device activity resource.

[`OrgDeviceActivityCreateRequest`](/documentation/AppleBusinessAPI/OrgDeviceActivityCreateRequest)

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

[`OrgDeviceActivityResponse`](/documentation/AppleBusinessAPI/OrgDeviceActivityResponse)

A response that contains a single organization device activity resource.

[`AppleCareCoverage`](/documentation/AppleBusinessAPI/AppleCareCoverage)

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

[`AppleCareCoverageResponse`](/documentation/AppleBusinessAPI/AppleCareCoverageResponse)

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

[`User`](/documentation/AppleBusinessAPI/User)

The data structure that represents a user resource.

[`UserResponse`](/documentation/AppleBusinessAPI/UserResponse)

A response that contains a single user resource.

[`UsersResponse`](/documentation/AppleBusinessAPI/UsersResponse)

A response that contains a list of user resources.

[`UserPhoneNumber`](/documentation/AppleBusinessAPI/UserPhoneNumber)

The data structure that represents a user’s phone number.

[`UserRoleOuMapping`](/documentation/AppleBusinessAPI/UserRoleOuMapping)

The data structure that represents a user’s role and organizational unit mapping.

[`UserGroup`](/documentation/AppleBusinessAPI/UserGroup)

The data structure that represents a user group resource.

[`UserGroupResponse`](/documentation/AppleBusinessAPI/UserGroupResponse)

A response that contains a single user group resource.

[`UserGroupsResponse`](/documentation/AppleBusinessAPI/UserGroupsResponse)

A response that contains a list of user group resources.

[`UserGroupUsersLinkagesResponse`](/documentation/AppleBusinessAPI/UserGroupUsersLinkagesResponse)

A response that contains a list of user IDs for a user group.

[`OrganizationalUnit`](/documentation/AppleBusinessAPI/OrganizationalUnit)

The data structure that represents an organizational unit resource.

[`OrganizationalUnitResponse`](/documentation/AppleBusinessAPI/OrganizationalUnitResponse)

A response that contains a single organizational unit resource.

[`OrganizationalUnitsResponse`](/documentation/AppleBusinessAPI/OrganizationalUnitsResponse)

A response that contains a list of organizational unit resources.

[`OrganizationalUnitUsersLinkagesResponse`](/documentation/AppleBusinessAPI/OrganizationalUnitUsersLinkagesResponse)

A response that contains a list of user IDs for an organizational unit.

[`App`](/documentation/AppleBusinessAPI/App)

The data structure that represents an app resource.

[`AppResponse`](/documentation/AppleBusinessAPI/AppResponse)

A response that contains information about an app resource.

[`AppsResponse`](/documentation/AppleBusinessAPI/AppsResponse)

A response that contains a list of app resources.

[`Package`](/documentation/AppleBusinessAPI/Package)

The data structure that represents a package resource.

[`PackageResponse`](/documentation/AppleBusinessAPI/PackageResponse)

A response that contains information about a package resource.

[`PackagesResponse`](/documentation/AppleBusinessAPI/PackagesResponse)

A response that contains a list of package resources.

[`Blueprint`](/documentation/AppleBusinessAPI/Blueprint)

The data structure that represents a Blueprint resource.

[`BlueprintResponse`](/documentation/AppleBusinessAPI/BlueprintResponse)

A response that contains information about a Blueprint resource.

[`BlueprintsResponse`](/documentation/AppleBusinessAPI/BlueprintsResponse)

A response that contains a list of Blueprint resources.

[`BlueprintCreateRequest`](/documentation/AppleBusinessAPI/BlueprintCreateRequest)

A request to create a new Blueprint.

[`BlueprintUpdateRequest`](/documentation/AppleBusinessAPI/BlueprintUpdateRequest)

A request to update an existing Blueprint.

[`BlueprintAppsLinkagesRequest`](/documentation/AppleBusinessAPI/BlueprintAppsLinkagesRequest)

A request to get a list of app resource linkages for a Blueprint.

[`BlueprintAppsLinkagesResponse`](/documentation/AppleBusinessAPI/BlueprintAppsLinkagesResponse)

A response that contains a list of app resource linkages for a Blueprint.

[`BlueprintConfigurationsLinkagesRequest`](/documentation/AppleBusinessAPI/BlueprintConfigurationsLinkagesRequest)

A request to get a list of Configuration resource linkages for a Blueprint.

[`BlueprintConfigurationsLinkagesResponse`](/documentation/AppleBusinessAPI/BlueprintConfigurationsLinkagesResponse)

A response that contains a list of Configuration resource linkages for a Blueprint.

[`BlueprintPackagesLinkagesRequest`](/documentation/AppleBusinessAPI/BlueprintPackagesLinkagesRequest)

A request to get a list of package resource linkages for a Blueprint.

[`BlueprintPackagesLinkagesResponse`](/documentation/AppleBusinessAPI/BlueprintPackagesLinkagesResponse)

A response that contains a list of package resource linkages for a Blueprint.

[`BlueprintOrgDevicesLinkagesRequest`](/documentation/AppleBusinessAPI/BlueprintOrgDevicesLinkagesRequest)

A request to get a list of device resource linkages for a Blueprint.

[`BlueprintOrgDevicesLinkagesResponse`](/documentation/AppleBusinessAPI/BlueprintOrgDevicesLinkagesResponse)

A response that contains a list of device resource linkages for a Blueprint.

[`BlueprintUsersLinkagesRequest`](/documentation/AppleBusinessAPI/BlueprintUsersLinkagesRequest)

A request to get a list of user resource linkages for a Blueprint.

[`BlueprintUsersLinkagesResponse`](/documentation/AppleBusinessAPI/BlueprintUsersLinkagesResponse)

A response that contains a list of user resource linkages for a Blueprint.

[`BlueprintUserGroupsLinkagesRequest`](/documentation/AppleBusinessAPI/BlueprintUserGroupsLinkagesRequest)

A request to get a list of user group resource linkages for a Blueprint.

[`BlueprintUserGroupsLinkagesResponse`](/documentation/AppleBusinessAPI/BlueprintUserGroupsLinkagesResponse)

A response that contains a list of user group resource linkages for a Blueprint.

[`Configuration`](/documentation/AppleBusinessAPI/Configuration)

The data structure that represents a Configuration resource.

[`ConfigurationResponse`](/documentation/AppleBusinessAPI/ConfigurationResponse)

A response that contains information about a Configuration resource.

[`ConfigurationsResponse`](/documentation/AppleBusinessAPI/ConfigurationsResponse)

A response that contains a list of Configuration resources.

[`ConfigurationCreateRequest`](/documentation/AppleBusinessAPI/ConfigurationCreateRequest)

A request to create a new Configuration.

[`ConfigurationUpdateRequest`](/documentation/AppleBusinessAPI/ConfigurationUpdateRequest)

A request to update an existing Configuration.

[`ConfigurationCommon`](/documentation/AppleBusinessAPI/ConfigurationCommon)

[`ConfigurationCustomSetting`](/documentation/AppleBusinessAPI/ConfigurationCustomSetting)

[`CustomSettingsValues`](/documentation/AppleBusinessAPI/CustomSettingsValues)

The custom settings payload for a Configuration of type `CUSTOM_SETTING`.

[`PagedDocumentLinks`](/documentation/AppleBusinessAPI/PagedDocumentLinks)

Links related to the response document, including paging links.

[`PagingInformation`](/documentation/AppleBusinessAPI/PagingInformation)

Paging information for data responses.

[`RelationshipLinks`](/documentation/AppleBusinessAPI/RelationshipLinks)

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

[`ResourceLinks`](/documentation/AppleBusinessAPI/ResourceLinks)

Self-links to requested resources.

[`ErrorResponse`](/documentation/AppleBusinessAPI/ErrorResponse)

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

[`ErrorLinks`](/documentation/AppleBusinessAPI/ErrorLinks)

[`JsonPointer`](/documentation/AppleBusinessAPI/JsonPointer)

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

[`Parameter`](/documentation/AppleBusinessAPI/Parameter)

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

[`DocumentLinks`](/documentation/AppleBusinessAPI/DocumentLinks)

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

### Type Aliases

[`OrgDeviceActivityType`](/documentation/AppleBusinessAPI/OrgDeviceActivityType)

Strings that represent organization device activities.

[`AppleCareCoveragePaymentType`](/documentation/AppleBusinessAPI/AppleCareCoveragePaymentType)

Strings that represent AppleCare coverage payment types.

[`AppleCareCoverageStatus`](/documentation/AppleBusinessAPI/AppleCareCoverageStatus)

Strings that represent AppleCare coverage status.

[`UserStatus`](/documentation/AppleBusinessAPI/UserStatus)

Strings that represent user statuses.

[`UserPhoneNumberType`](/documentation/AppleBusinessAPI/UserPhoneNumberType)

Strings that represent phone number types.

[`UserGroupStatus`](/documentation/AppleBusinessAPI/UserGroupStatus)

Strings that represent user group statuses.

[`UserGroupType`](/documentation/AppleBusinessAPI/UserGroupType)

Strings that represent user group types.

[`SupportedOS`](/documentation/AppleBusinessAPI/SupportedOS)

The supported operating systems for an app.

[`BlueprintStatus`](/documentation/AppleBusinessAPI/BlueprintStatus)

The status of a Blueprint.

[`ConfigurationType`](/documentation/AppleBusinessAPI/ConfigurationType)

The type of Configuration profile.

[`ConfigurationPlatform`](/documentation/AppleBusinessAPI/ConfigurationPlatform)

The platform that a Configuration targets.


---

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)