--- title: Apple Business API framework: Apple Business API role: collection role_heading: Web Service platforms: [apple business api 2.5+] path: applebusinessapi --- # Apple Business API Automate device management activities, view device information, and manage users and user groups in Apple Business. ## Overview Overview note: This API is a part of the Apple School Manager and Apple Business APIs collection. ## Topics ### Authentication - [Implementing OAuth for the Apple School Manager and Apple Business API](apple-school-and-business-manager-api/implementing-oauth-for-the-apple-school-manager-and-apple-business-api.md) ### Devices - [Get Organization Devices](applebusinessapi/get-org-devices.md) - [Get Device Information](applebusinessapi/get-orgdevice-information.md) - [Get AppleCare coverage Information for a Device](applebusinessapi/get-all-applecare-coverage-for-an-orgdevice.md) - [Get Devices Enrolled in Apple Device Management Service](applebusinessapi/get-apple-mdm-enrolled-devices.md) - [Get Details for a Device Enrolled in Apple Device Management Service](applebusinessapi/get-the-details-for-apple-mdm-enrolled-device.md) ### Device Management Services - [Get Device Management Services](applebusinessapi/get-mdm-servers.md) - [Get Device Management Service Information](applebusinessapi/get-mdmserver-information.md) - [Create a Device Management Service](applebusinessapi/create-an-mdmserver.md) - [Update a Device Management Service](applebusinessapi/update-an-mdmserver.md) - [Delete a Device Management Service](applebusinessapi/delete-an-mdmserver.md) - [Get the Device Serial Numbers for a Device Management Service](applebusinessapi/get-all-device-ids-for-an-mdmserver.md) - [Get the Assigned Device Management Service ID for a Device](applebusinessapi/get-the-assigned-server-id-for-an-orgdevice.md) - [Get the Assigned Device Management Service Information for a Device](applebusinessapi/get-the-assigned-server-information-for-an-orgdevice.md) - [Assign or Unassign Devices to a Device Management Service or Release Devices](applebusinessapi/create-an-orgdeviceactivity.md) - [Get Organization Device Activity Information](applebusinessapi/get-orgdeviceactivity-information.md) ### Users - [Get Users](applebusinessapi/get-users.md) - [Get User Information](applebusinessapi/get-user-information.md) ### UserGroups - [Get User Groups](applebusinessapi/get-user-groups.md) - [Get User Group Information](applebusinessapi/get-usergroup-information.md) - [Get User IDs for a User Group](applebusinessapi/get-all-user-ids-for-a-user-group.md) ### Organizational Units - [Get Organizational Units](applebusinessapi/get-organizational-units.md) - [Get Organizational Unit Information](applebusinessapi/get-organizationalunit-information.md) - [Get User IDs for an Organizational Unit](applebusinessapi/get-all-user-ids-for-an-organizationalunit.md) ### Apps and Packages - [Get Apps](applebusinessapi/get-apps.md) - [Get App Information](applebusinessapi/get-app-information.md) - [Get Packages](applebusinessapi/get-packages.md) - [Get Package Information](applebusinessapi/get-package-information.md) ### Blueprints - [Get Blueprints](applebusinessapi/get-blueprints.md) - [Create a Blueprint](applebusinessapi/create-a-blueprint.md) - [Get Blueprint Information](applebusinessapi/get-blueprint-information.md) - [Update a Blueprint](applebusinessapi/update-a-blueprint.md) - [Delete a Blueprint](applebusinessapi/delete-a-blueprint.md) - [Get App IDs for a Blueprint](applebusinessapi/get-all-app-ids-for-a-blueprint.md) - [Add Apps to a Blueprint](applebusinessapi/add-apps-to-a-blueprint.md) - [Remove Apps from a Blueprint](applebusinessapi/remove-apps-from-a-blueprint.md) - [Get Configuration IDs for a Blueprint](applebusinessapi/get-all-configuration-ids-for-a-blueprint.md) - [Add Configurations to a Blueprint](applebusinessapi/add-configurations-to-a-blueprint.md) - [Remove Configurations from a Blueprint](applebusinessapi/remove-configurations-from-a-blueprint.md) - [Get Package IDs for a Blueprint](applebusinessapi/get-all-package-ids-for-a-blueprint.md) - [Add Packages to a Blueprint](applebusinessapi/add-packages-to-a-blueprint.md) - [Remove Packages from a Blueprint](applebusinessapi/remove-packages-from-a-blueprint.md) - [Get Device IDs for a Blueprint](applebusinessapi/get-all-orgdevice-ids-for-a-blueprint.md) - [Add Devices to a Blueprint](applebusinessapi/add-org-devices-to-a-blueprint.md) - [Remove Devices from a Blueprint](applebusinessapi/remove-org-devices-from-a-blueprint.md) - [Get User IDs for a Blueprint](applebusinessapi/get-all-user-ids-for-a-blueprint.md) - [Add Users to a Blueprint](applebusinessapi/add-users-to-a-blueprint.md) - [Remove Users from a Blueprint](applebusinessapi/remove-users-from-a-blueprint.md) - [Get User Group IDs for a Blueprint](applebusinessapi/get-all-user-group-ids-for-a-blueprint.md) - [Add User Groups to a Blueprint](applebusinessapi/add-user-groups-to-a-blueprint.md) - [Remove User Groups from a Blueprint](applebusinessapi/remove-user-groups-from-a-blueprint.md) ### Configurations - [Get Configurations](applebusinessapi/get-configurations.md) - [Create a Configuration](applebusinessapi/create-a-configuration.md) - [Get Configuration Information](applebusinessapi/get-configuration-information.md) - [Update a Configuration](applebusinessapi/update-a-configuration.md) - [Delete a Configuration](applebusinessapi/delete-a-configuration.md) ### Audit Events - [Get Audit Events](applebusinessapi/get-audit-events.md) ### Objects and Data Types - [OrgDevice](applebusinessapi/orgdevice.md) - [OrgDeviceResponse](applebusinessapi/orgdeviceresponse.md) - [OrgDevicesResponse](applebusinessapi/orgdevicesresponse.md) - [OrgDeviceAssignedServerLinkageResponse](applebusinessapi/orgdeviceassignedserverlinkageresponse.md) - [MdmDevice](applebusinessapi/mdmdevice.md) - [MdmDeviceResponse](applebusinessapi/mdmdeviceresponse.md) - [MdmDevicesResponse](applebusinessapi/mdmdevicesresponse.md) - [MdmDeviceDetail](applebusinessapi/mdmdevicedetail.md) - [MdmDeviceDetailResponse](applebusinessapi/mdmdevicedetailresponse.md) - [MdmServer](applebusinessapi/mdmserver.md) - [MdmServerResponse](applebusinessapi/mdmserverresponse.md) - [MdmServersResponse](applebusinessapi/mdmserversresponse.md) - [MdmServerDevicesLinkagesResponse](applebusinessapi/mdmserverdeviceslinkagesresponse.md) - [OrgDeviceActivity](applebusinessapi/orgdeviceactivity.md) - [OrgDeviceActivityCreateRequest](applebusinessapi/orgdeviceactivitycreaterequest.md) - [OrgDeviceActivityResponse](applebusinessapi/orgdeviceactivityresponse.md) - [AppleCareCoverage](applebusinessapi/applecarecoverage.md) - [AppleCareCoverageResponse](applebusinessapi/applecarecoverageresponse.md) - [User](applebusinessapi/user.md) - [UserResponse](applebusinessapi/userresponse.md) - [UsersResponse](applebusinessapi/usersresponse.md) - [UserPhoneNumber](applebusinessapi/userphonenumber.md) - [UserRoleOuMapping](applebusinessapi/userroleoumapping.md) - [UserGroup](applebusinessapi/usergroup.md) - [UserGroupResponse](applebusinessapi/usergroupresponse.md) - [UserGroupsResponse](applebusinessapi/usergroupsresponse.md) - [UserGroupUsersLinkagesResponse](applebusinessapi/usergroupuserslinkagesresponse.md) - [OrganizationalUnit](applebusinessapi/organizationalunit.md) - [OrganizationalUnitResponse](applebusinessapi/organizationalunitresponse.md) - [OrganizationalUnitsResponse](applebusinessapi/organizationalunitsresponse.md) - [OrganizationalUnitUsersLinkagesResponse](applebusinessapi/organizationalunituserslinkagesresponse.md) - [App](applebusinessapi/app.md) - [AppResponse](applebusinessapi/appresponse.md) - [AppsResponse](applebusinessapi/appsresponse.md) - [Package](applebusinessapi/package.md) - [PackageResponse](applebusinessapi/packageresponse.md) - [PackagesResponse](applebusinessapi/packagesresponse.md) - [Blueprint](applebusinessapi/blueprint.md) - [BlueprintResponse](applebusinessapi/blueprintresponse.md) - [BlueprintsResponse](applebusinessapi/blueprintsresponse.md) - [BlueprintCreateRequest](applebusinessapi/blueprintcreaterequest.md) - [BlueprintUpdateRequest](applebusinessapi/blueprintupdaterequest.md) - [BlueprintAppsLinkagesRequest](applebusinessapi/blueprintappslinkagesrequest.md) - [BlueprintAppsLinkagesResponse](applebusinessapi/blueprintappslinkagesresponse.md) - [BlueprintConfigurationsLinkagesRequest](applebusinessapi/blueprintconfigurationslinkagesrequest.md) - [BlueprintConfigurationsLinkagesResponse](applebusinessapi/blueprintconfigurationslinkagesresponse.md) - [BlueprintPackagesLinkagesRequest](applebusinessapi/blueprintpackageslinkagesrequest.md) - [BlueprintPackagesLinkagesResponse](applebusinessapi/blueprintpackageslinkagesresponse.md) - [BlueprintOrgDevicesLinkagesRequest](applebusinessapi/blueprintorgdeviceslinkagesrequest.md) - [BlueprintOrgDevicesLinkagesResponse](applebusinessapi/blueprintorgdeviceslinkagesresponse.md) - [BlueprintUsersLinkagesRequest](applebusinessapi/blueprintuserslinkagesrequest.md) - [BlueprintUsersLinkagesResponse](applebusinessapi/blueprintuserslinkagesresponse.md) - [BlueprintUserGroupsLinkagesRequest](applebusinessapi/blueprintusergroupslinkagesrequest.md) - [BlueprintUserGroupsLinkagesResponse](applebusinessapi/blueprintusergroupslinkagesresponse.md) - [Configuration](applebusinessapi/configuration.md) - [ConfigurationResponse](applebusinessapi/configurationresponse.md) - [ConfigurationsResponse](applebusinessapi/configurationsresponse.md) - [ConfigurationCreateRequest](applebusinessapi/configurationcreaterequest.md) - [ConfigurationUpdateRequest](applebusinessapi/configurationupdaterequest.md) - [ConfigurationCommon](applebusinessapi/configurationcommon.md) - [ConfigurationCustomSetting](applebusinessapi/configurationcustomsetting.md) - [CustomSettingsValues](applebusinessapi/customsettingsvalues.md) - [PagedDocumentLinks](applebusinessapi/pageddocumentlinks.md) - [PagingInformation](applebusinessapi/paginginformation.md) - [RelationshipLinks](applebusinessapi/relationshiplinks.md) - [ResourceLinks](applebusinessapi/resourcelinks.md) - [ErrorResponse](applebusinessapi/errorresponse.md) - [ErrorLinks](applebusinessapi/errorlinks.md) - [JsonPointer](applebusinessapi/jsonpointer.md) - [Parameter](applebusinessapi/parameter.md) - [DocumentLinks](applebusinessapi/documentlinks.md) ### Type Aliases - [OrgDeviceActivityType](applebusinessapi/orgdeviceactivitytype.md) - [AppleCareCoveragePaymentType](applebusinessapi/applecarecoveragepaymenttype.md) - [AppleCareCoverageStatus](applebusinessapi/applecarecoveragestatus.md) - [UserStatus](applebusinessapi/userstatus.md) - [UserPhoneNumberType](applebusinessapi/userphonenumbertype.md) - [UserGroupStatus](applebusinessapi/usergroupstatus.md) - [UserGroupType](applebusinessapi/usergrouptype.md) - [SupportedOS](applebusinessapi/supportedos.md) - [BlueprintStatus](applebusinessapi/blueprintstatus.md) - [ConfigurationType](applebusinessapi/configurationtype.md) - [ConfigurationPlatform](applebusinessapi/configurationplatform.md) - [ActivationLockType](applebusinessapi/activationlocktype.md) - [AuditEventActorType](applebusinessapi/auditeventactortype.md) - [AuditEventCategory](applebusinessapi/auditeventcategory.md) - [AuditEventOutcome](applebusinessapi/auditeventoutcome.md) - [AuditEventPurchaseSourceType](applebusinessapi/auditeventpurchasesourcetype.md) - [AuditEventReleaseEntityType](applebusinessapi/auditeventreleaseentitytype.md) - [AuditEventSubjectType](applebusinessapi/auditeventsubjecttype.md) - [AuditEventType](applebusinessapi/auditeventtype.md) - [DeviceEraseStatus](applebusinessapi/deviceerasestatus.md) - [DeviceLockStatus](applebusinessapi/devicelockstatus.md) - [LostModeStatus](applebusinessapi/lostmodestatus.md) - [MdmMigrationStatus](applebusinessapi/mdmmigrationstatus.md) ### Endpoints - [Get the Activation Lock Status for a Device](applebusinessapi/get-the-activation-lock-status-information-for-an-orgdevice.md) ### Dictionaries - [ActivationLockStatus](applebusinessapi/activationlockstatus.md) - [ActivityTypeMetadata](applebusinessapi/activitytypemetadata.md) - [AuditEvent](applebusinessapi/auditevent.md) - [AuditEventAccountAdded](applebusinessapi/auditeventaccountadded.md) - [AuditEventAccountAddedAttributes](applebusinessapi/auditeventaccountaddedattributes.md) - [AuditEventAccountDeleted](applebusinessapi/auditeventaccountdeleted.md) - [AuditEventAccountDeletedAttributes](applebusinessapi/auditeventaccountdeletedattributes.md) - [AuditEventAccountRoleLocation](applebusinessapi/auditeventaccountrolelocation.md) - [AuditEventAccountRoleLocationChanged](applebusinessapi/auditeventaccountrolelocationchanged.md) - [AuditEventAccountRoleLocationChangedAttributes](applebusinessapi/auditeventaccountrolelocationchangedattributes.md) - [AuditEventApiAccountCreatedWithKey](applebusinessapi/auditeventapiaccountcreatedwithkey.md) - [AuditEventApiAccountCreatedWithKeyAttributes](applebusinessapi/auditeventapiaccountcreatedwithkeyattributes.md) - [AuditEventApiAccountCreatedWithoutKey](applebusinessapi/auditeventapiaccountcreatedwithoutkey.md) - [AuditEventApiAccountCreatedWithoutKeyAttributes](applebusinessapi/auditeventapiaccountcreatedwithoutkeyattributes.md) - [AuditEventApiAccountDeleted](applebusinessapi/auditeventapiaccountdeleted.md) - [AuditEventApiAccountDeletedAttributes](applebusinessapi/auditeventapiaccountdeletedattributes.md) - [AuditEventApiAccountKeyGenerated](applebusinessapi/auditeventapiaccountkeygenerated.md) - [AuditEventApiAccountKeyGeneratedAttributes](applebusinessapi/auditeventapiaccountkeygeneratedattributes.md) - [AuditEventApiAccountKeyRevoked](applebusinessapi/auditeventapiaccountkeyrevoked.md) - [AuditEventApiAccountKeyRevokedAttributes](applebusinessapi/auditeventapiaccountkeyrevokedattributes.md) - [AuditEventApiAccountNameChanged](applebusinessapi/auditeventapiaccountnamechanged.md) - [AuditEventApiAccountNameChangedAttributes](applebusinessapi/auditeventapiaccountnamechangedattributes.md) - [AuditEventApiAccountRoleLocationChanged](applebusinessapi/auditeventapiaccountrolelocationchanged.md) - [AuditEventApiAccountRoleLocationChangedAttributes](applebusinessapi/auditeventapiaccountrolelocationchangedattributes.md) - [AuditEventCollectionCreated](applebusinessapi/auditeventcollectioncreated.md) - [AuditEventCollectionCreatedAttributes](applebusinessapi/auditeventcollectioncreatedattributes.md) - [AuditEventCollectionDeleted](applebusinessapi/auditeventcollectiondeleted.md) - [AuditEventCollectionDeletedAttributes](applebusinessapi/auditeventcollectiondeletedattributes.md) - [AuditEventCollectionUpdated](applebusinessapi/auditeventcollectionupdated.md) - [AuditEventCollectionUpdatedAttributes](applebusinessapi/auditeventcollectionupdatedattributes.md) - [AuditEventCommonAttributes](applebusinessapi/auditeventcommonattributes.md) - [AuditEventConfigSettingsCreated](applebusinessapi/auditeventconfigsettingscreated.md) - [AuditEventConfigSettingsCreatedAttributes](applebusinessapi/auditeventconfigsettingscreatedattributes.md) - [AuditEventConfigSettingsDeleted](applebusinessapi/auditeventconfigsettingsdeleted.md) - [AuditEventConfigSettingsDeletedAttributes](applebusinessapi/auditeventconfigsettingsdeletedattributes.md) - [AuditEventConfigSettingsUpdated](applebusinessapi/auditeventconfigsettingsupdated.md) - [AuditEventConfigSettingsUpdatedAttributes](applebusinessapi/auditeventconfigsettingsupdatedattributes.md) - [AuditEventDeviceAddedToOrg](applebusinessapi/auditeventdeviceaddedtoorg.md) - [AuditEventDeviceAddedToOrgAttributes](applebusinessapi/auditeventdeviceaddedtoorgattributes.md) - [AuditEventDeviceAssignedToServer](applebusinessapi/auditeventdeviceassignedtoserver.md) - [AuditEventDeviceAssignedToServerAttributes](applebusinessapi/auditeventdeviceassignedtoserverattributes.md) - [AuditEventDeviceIsErased](applebusinessapi/auditeventdeviceiserased.md) - [AuditEventDeviceIsErasedAttributes](applebusinessapi/auditeventdeviceiserasedattributes.md) - [AuditEventDeviceRemovedFromOrg](applebusinessapi/auditeventdeviceremovedfromorg.md) - [AuditEventDeviceRemovedFromOrgAttributes](applebusinessapi/auditeventdeviceremovedfromorgattributes.md) - [AuditEventDeviceUnassignedFromServer](applebusinessapi/auditeventdeviceunassignedfromserver.md) - [AuditEventDeviceUnassignedFromServerAttributes](applebusinessapi/auditeventdeviceunassignedfromserverattributes.md) - [AuditEventDomainAdded](applebusinessapi/auditeventdomainadded.md) - [AuditEventDomainAddedAttributes](applebusinessapi/auditeventdomainaddedattributes.md) - [AuditEventDomainRemoved](applebusinessapi/auditeventdomainremoved.md) - [AuditEventDomainRemovedAttributes](applebusinessapi/auditeventdomainremovedattributes.md) - [AuditEventDomainVerified](applebusinessapi/auditeventdomainverified.md) - [AuditEventDomainVerifiedAttributes](applebusinessapi/auditeventdomainverifiedattributes.md) - [AuditEventExternalAccountAssociated](applebusinessapi/auditeventexternalaccountassociated.md) - [AuditEventExternalAccountAssociatedAttributes](applebusinessapi/auditeventexternalaccountassociatedattributes.md) - [AuditEventExternalAccountDisassociated](applebusinessapi/auditeventexternalaccountdisassociated.md) - [AuditEventExternalAccountDisassociatedAttributes](applebusinessapi/auditeventexternalaccountdisassociatedattributes.md) - [AuditEventSubjectHasAppleCarePurchaseAdded](applebusinessapi/auditeventsubjecthasapplecarepurchaseadded.md) - [AuditEventSubjectHasAppleCarePurchaseRemoved](applebusinessapi/auditeventsubjecthasapplecarepurchaseremoved.md) - [AuditEventSubjectHasApplecarePurchaseAddedAttributes](applebusinessapi/auditeventsubjecthasapplecarepurchaseaddedattributes.md) - [AuditEventSubjectHasApplecarePurchaseRemovedAttributes](applebusinessapi/auditeventsubjecthasapplecarepurchaseremovedattributes.md) - [AuditEventSubjectHasICloudStoragePurchaseAdded](applebusinessapi/auditeventsubjecthasicloudstoragepurchaseadded.md) - [AuditEventSubjectHasICloudStoragePurchaseRemoved](applebusinessapi/auditeventsubjecthasicloudstoragepurchaseremoved.md) - [AuditEventSubjectHasIcloudStoragePurchaseAddedAttributes](applebusinessapi/auditeventsubjecthasicloudstoragepurchaseaddedattributes.md) - [AuditEventSubjectHasIcloudStoragePurchaseRemovedAttributes](applebusinessapi/auditeventsubjecthasicloudstoragepurchaseremovedattributes.md) - [AuditEventSubscriptionCreated](applebusinessapi/auditeventsubscriptioncreated.md) - [AuditEventSubscriptionCreatedAttributes](applebusinessapi/auditeventsubscriptioncreatedattributes.md) - [AuditEventSubscriptionDeleted](applebusinessapi/auditeventsubscriptiondeleted.md) - [AuditEventSubscriptionDeletedAttributes](applebusinessapi/auditeventsubscriptiondeletedattributes.md) - [AuditEventSubscriptionUpdated](applebusinessapi/auditeventsubscriptionupdated.md) - [AuditEventSubscriptionUpdatedAttributes](applebusinessapi/auditeventsubscriptionupdatedattributes.md) - [MdmServerCreateRequest](applebusinessapi/mdmservercreaterequest.md) - [MdmServerUpdateRequest](applebusinessapi/mdmserverupdaterequest.md) ## See Also ### Apple School Manager and Apple Business APIs - [Apple School Manager API](appleschoolmanagerapi.md)