Apple Business

App · 20 actions

Manage the Apple devices your organization owns: find devices, assign them to your device management service, release them, check AppleCare and Activation Lock, and add them to Blueprints. Start a workflow when a device is added, assigned, unassigned, released or erased.

Actions

ActionWhat it does
Add devices to a BlueprintAdd devices to a Blueprint, so they get its apps and settings.
Assign devices to a serviceAssign devices to a device management service, so they enroll in it when next set up.
Cancel a device moveCancel devices' scheduled move to another device management service.
Get Activation Lock statusCheck whether a device is Activation Locked, and whether by your device management service or a personal Apple Account.
Get AppleCare coverageGet a device's warranty and AppleCare coverage, with when each starts and ends.
Get deviceGet a device's details: model, order, purchase source, whether it is assigned, and when it was added or released.
Get device activityCheck how an assign, unassign, release or move is going, and get its log once it is done.
Get device management serviceGet a device management service's details, such as its status, device count and when it last connected to Apple.
Get device's management serviceGet the device management service (MDM server) a device is assigned to, if any.
Get userGet one person's details, such as their Managed Apple Account, roles and status.
List audit eventsList what happened in your organization over a period, such as devices added, assigned or erased, and who did it.
List BlueprintsList the Blueprints that give devices apps and settings through Apple Business's built-in device management.
List device management servicesList your organization's device management services (MDM servers), with how many devices each has.
List devicesList the devices in your organization, such as every unassigned Mac or the iPhones added this week.
List devices assigned to a serviceList the serial numbers of the devices assigned to a device management service.
List usersList the people in your organization, with their Managed Apple Account, department, job title and status.
Move devices to another serviceAssign enrolled devices to a new device management service and have them move to it without being erased, by a deadline up to 90 days away.
Release devices from the organizationPermanently release devices from your organization, such as ones sold or given away.
Remove devices from a BlueprintRemove devices from a Blueprint.
Unassign devices from a serviceUnassign devices from a device management service.

Add devices to a Blueprint

Add devices to a Blueprint, so they get its apps and settings.

Inputs

Blueprintblueprint_idtextRequired
The Blueprint. Pick one, or give its ID from an earlier step.
Devicesserial_numberslistRequired
The devices to add. Pick them, or give serial numbers.

Outputs

blueprint_idtext
The Blueprint
countnumber
How many
serial_numberslist
The devices' serial numbers
Example output
{
  "blueprint_id": "blueprint-12345",
  "count": 1,
  "serial_numbers": [
    "C02X1234ABCD"
  ]
}

Assign devices to a service

Assign devices to a device management service, so they enroll in it when next set up. Apple does this in the background; 'Get device activity' says when it is done.

Inputs

Device management serviceservice_idtextRequired
The device management service (MDM server). Pick one, or give its ID from an earlier step.
Devicesserial_numberslistRequired
The devices to assign. Pick them, or give serial numbers.

Outputs

activity_idtext
The activity's ID, for 'Get device activity'
completedtext
When it finished (ISO 8601)
createdtext
When it started (ISO 8601)
is_donetrue/false
Whether it has finished
log_urltext
A link to its log (a CSV file), once it has finished
serial_numberslist
The devices' serial numbers
statustext
COMPLETED, IN_PROGRESS, STOPPED or FAILED
sub_statustext
The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
succeededtrue/false
Whether it finished with every device done
Example output
{
  "activity_id": "b1481656-b267-480d-b284-a809eed8b041",
  "completed": null,
  "created": "2026-11-05T04:15:43.282Z",
  "is_done": false,
  "log_url": null,
  "serial_numbers": [
    "C02X1234ABCD"
  ],
  "status": "IN_PROGRESS",
  "sub_status": "SUBMITTED",
  "succeeded": false
}

Cancel a device move

Cancel devices' scheduled move to another device management service.

Inputs

Devicesserial_numberslistRequired
The devices whose move to cancel. Pick them, or give serial numbers.

Outputs

activity_idtext
The activity's ID, for 'Get device activity'
completedtext
When it finished (ISO 8601)
createdtext
When it started (ISO 8601)
is_donetrue/false
Whether it has finished
log_urltext
A link to its log (a CSV file), once it has finished
serial_numberslist
The devices' serial numbers
statustext
COMPLETED, IN_PROGRESS, STOPPED or FAILED
sub_statustext
The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
succeededtrue/false
Whether it finished with every device done
Example output
{
  "activity_id": "b1481656-b267-480d-b284-a809eed8b041",
  "completed": null,
  "created": "2026-11-05T04:15:43.282Z",
  "is_done": false,
  "log_url": null,
  "serial_numbers": [
    "C02X1234ABCD"
  ],
  "status": "IN_PROGRESS",
  "sub_status": "SUBMITTED",
  "succeeded": false
}

Get Activation Lock status

Check whether a device is Activation Locked, and whether by your device management service or a personal Apple Account.

Inputs

Deviceserial_numbertextRequired
The device. Pick one, or give its serial number from an earlier step.

Outputs

is_lockedtrue/false
Whether it is locked
lock_typetext
MDM, USER or NONE
serial_numbertext
The device's serial number
Example output
{
  "is_locked": true,
  "lock_type": "MDM",
  "serial_number": "C02X1234ABCD"
}

Get AppleCare coverage

Get a device's warranty and AppleCare coverage, with when each starts and ends.

Inputs

Deviceserial_numbertextRequired
The device. Pick one, or give its serial number from an earlier step.

Outputs

countnumber
How many
coverageslist
Its coverages
has_active_coveragetrue/false
Whether any coverage is active
serial_numbertext
The device's serial number
Example output
{
  "count": 1,
  "coverages": [
    {
      "agreementNumber": "0000000001",
      "contractCancelDateTime": null,
      "description": "AppleCare+",
      "endDateTime": "2027-04-17T00:00:00Z",
      "id": "0000000001",
      "isCanceled": false,
      "isRenewable": true,
      "paymentType": "SUBSCRIPTION",
      "startDateTime": "2026-04-17T00:00:00Z",
      "status": "ACTIVE"
    }
  ],
  "has_active_coverage": true,
  "serial_number": "C02X1234ABCD"
}

Get device

Get a device's details: model, order, purchase source, whether it is assigned, and when it was added or released.

Inputs

Deviceserial_numbertextRequired
The device. Pick one, or give its serial number from an earlier step.

Outputs

deviceobject
The device
Example output
{
  "device": {
    "addedToOrgDateTime": "2026-10-30T22:05:14.192Z",
    "bluetoothMacAddress": "a4:83:e7:12:34:57",
    "color": "SPACE GRAY",
    "deviceCapacity": "512GB",
    "deviceModel": "MacBook Pro 14-inch",
    "eid": null,
    "ethernetMacAddress": [],
    "id": "C02X1234ABCD",
    "imei": [],
    "isMdmMigrationCapable": true,
    "mdmMigrationDeadlineDateTime": null,
    "mdmMigrationStatus": null,
    "meid": [],
    "orderDateTime": "2026-10-28T07:00:00Z",
    "orderNumber": "W1234567890",
    "partNumber": "MTL73LL/A",
    "productFamily": "Mac",
    "productType": "Mac15,3",
    "purchaseSourceId": "1234567",
    "purchaseSourceType": "APPLE",
    "releasedFromOrgDateTime": null,
    "serialNumber": "C02X1234ABCD",
    "status": "ASSIGNED",
    "updatedDateTime": "2026-11-01T15:33:54.164Z",
    "wifiMacAddress": "a4:83:e7:12:34:56"
  }
}

Get device activity

Check how an assign, unassign, release or move is going, and get its log once it is done. Apple keeps activities for 30 days.

Inputs

Activity IDactivity_idtextRequired
The activity_id an earlier assign, unassign or release step returned.

Outputs

activity_idtext
The activity's ID, for 'Get device activity'
completedtext
When it finished (ISO 8601)
createdtext
When it started (ISO 8601)
is_donetrue/false
Whether it has finished
log_urltext
A link to its log (a CSV file), once it has finished
statustext
COMPLETED, IN_PROGRESS, STOPPED or FAILED
sub_statustext
The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
succeededtrue/false
Whether it finished with every device done
Example output
{
  "activity_id": "b1481656-b267-480d-b284-a809eed8b041",
  "completed": "2026-11-05T04:15:58.894Z",
  "created": "2026-11-05T04:15:43.282Z",
  "is_done": true,
  "log_url": "https://store.blobstore.apple.com/activity-log.csv",
  "status": "COMPLETED",
  "sub_status": "COMPLETED_WITH_SUCCESS",
  "succeeded": true
}

Get device management service

Get a device management service's details, such as its status, device count and when it last connected to Apple.

Inputs

Device management serviceservice_idtextRequired
The device management service (MDM server). Pick one, or give its ID from an earlier step.

Outputs

serviceobject
The service
Example output
{
  "service": {
    "createdDateTime": "2025-05-01T03:21:44Z",
    "defaultProductFamilies": [
      "MAC",
      "IPHONE",
      "IPAD"
    ],
    "deviceCount": 128,
    "enableMdmDisownFlag": false,
    "id": "1F97349736CF4614A94F624E705841AD",
    "lastConnectedDateTime": "2026-11-05T08:14:23Z",
    "lastConnectedIp": "203.0.113.5",
    "serverName": "Production MDM",
    "serverType": "MDM",
    "status": "ACTIVE",
    "updatedDateTime": "2026-05-12T11:02:18Z"
  }
}

Get device's management service

Get the device management service (MDM server) a device is assigned to, if any.

Inputs

Deviceserial_numbertextRequired
The device. Pick one, or give its serial number from an earlier step.

Outputs

is_assignedtrue/false
Whether it is assigned to one
serial_numbertext
The device's serial number
serviceobject
The service, if it is assigned
Example output
{
  "is_assigned": true,
  "serial_number": "C02X1234ABCD",
  "service": {
    "createdDateTime": "2025-05-01T03:21:44Z",
    "defaultProductFamilies": [
      "MAC",
      "IPHONE",
      "IPAD"
    ],
    "deviceCount": 128,
    "enableMdmDisownFlag": false,
    "id": "1F97349736CF4614A94F624E705841AD",
    "lastConnectedDateTime": "2026-11-05T08:14:23Z",
    "lastConnectedIp": "203.0.113.5",
    "serverName": "Production MDM",
    "serverType": "MDM",
    "status": "ACTIVE",
    "updatedDateTime": "2026-05-12T11:02:18Z"
  }
}

Get user

Get one person's details, such as their Managed Apple Account, roles and status.

Inputs

Useraccount_user_idtextRequired
The person. Pick one, or give their ID from an earlier step.

Outputs

userobject
The user
Example output
{
  "user": {
    "costCenter": "CC100",
    "createdDateTime": "2026-01-10T10:30:00Z",
    "department": "IT",
    "division": "Operations",
    "email": "jo.rivera@example.com",
    "employeeNumber": "EMP001",
    "firstName": "Jo",
    "id": "1234567890",
    "isExternalUser": false,
    "jobTitle": "Support Specialist",
    "lastName": "Rivera",
    "managedAppleAccount": "jo.rivera@appleid.example.com",
    "middleName": null,
    "phoneNumbers": [
      {
        "phoneNumber": "+1-555-123-4567",
        "type": "WORK"
      }
    ],
    "roleOuList": [
      {
        "ouId": "OU123456",
        "roleName": "Staff"
      }
    ],
    "startDateTime": "2026-01-15T08:00:00Z",
    "status": "ACTIVE",
    "updatedDateTime": "2026-06-01T14:22:00Z"
  }
}

List audit events

List what happened in your organization over a period, such as devices added, assigned or erased, and who did it.

Inputs

Fromstart_timedate and timeRequired
The start of the period.
Untilend_timedate and time
The end of the period. Defaults to now.
Eventevent_typetext
Only this kind of event. Leave empty for every kind.One of: DEVICE_ADDED_TO_ORG (Device added to organization), DEVICE_REMOVED_FROM_ORG (Device removed from organization), DEVICE_ASSIGNED_TO_SERVER (Device assigned to a device management service), DEVICE_UNASSIGNED_FROM_SERVER (Device unassigned from a device management service), DEVICE_IS_ERASED (Device erased), SUBJECT_HAS_APPLECARE_PURCHASE_ADDED (AppleCare purchase added), SUBJECT_HAS_APPLECARE_PURCHASE_REMOVED (AppleCare purchase removed), SUBJECT_HAS_ICLOUD_STORAGE_PURCHASE_ADDED (iCloud storage purchase added), SUBJECT_HAS_ICLOUD_STORAGE_PURCHASE_REMOVED (iCloud storage purchase removed), CONFIG_SETTINGS_CREATED (Configuration settings created), and 43 more.
Done by (ID)actor_idtext
Only events done by this user or API account ID.
Done to (ID)subject_idtext
Only events about this ID, such as a user's ID.
Maximum resultslimitnumber
The most events to return, up to 5000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many
eventslist
The events
has_moretrue/false
True if there were more than the maximum asked for
Example output
{
  "count": 1,
  "events": [
    {
      "actorId": "user-abc123",
      "actorName": "it@example.com",
      "actorType": "USER",
      "category": "DEVICE_INVENTORY",
      "details": {
        "serialNumber": "C02X1234ABCD",
        "targetServerName": "Production MDM"
      },
      "eventDataPropertyKey": "eventDataDeviceAssignedToServer",
      "eventDateTime": "2026-11-05T12:00:00Z",
      "groupId": "group-001",
      "id": "event-12345",
      "outcome": "SUCCESS",
      "subjectId": "C02X1234ABCD",
      "subjectName": "MacBook Pro",
      "subjectType": "DEVICE",
      "type": "DEVICE_ASSIGNED_TO_SERVER"
    }
  ],
  "has_more": false
}

List Blueprints

List the Blueprints that give devices apps and settings through Apple Business's built-in device management.

Inputs

None.

Outputs

blueprintslist
The Blueprints
countnumber
How many
Example output
{
  "blueprints": [
    {
      "appLicenseDeficient": false,
      "createdDateTime": "2026-01-15T10:30:00Z",
      "description": "Standard apps for engineering team",
      "id": "blueprint-12345",
      "name": "Engineering Onboarding",
      "status": "ACTIVE",
      "updatedDateTime": "2026-06-01T14:22:00Z"
    }
  ],
  "count": 1
}

List device management services

List your organization's device management services (MDM servers), with how many devices each has.

Inputs

None.

Outputs

countnumber
How many
serviceslist
The services
Example output
{
  "count": 1,
  "services": [
    {
      "createdDateTime": "2025-05-01T03:21:44Z",
      "defaultProductFamilies": [
        "MAC",
        "IPHONE",
        "IPAD"
      ],
      "deviceCount": 128,
      "enableMdmDisownFlag": false,
      "id": "1F97349736CF4614A94F624E705841AD",
      "lastConnectedDateTime": "2026-11-05T08:14:23Z",
      "lastConnectedIp": "203.0.113.5",
      "serverName": "Production MDM",
      "serverType": "MDM",
      "status": "ACTIVE",
      "updatedDateTime": "2026-05-12T11:02:18Z"
    }
  ]
}

List devices

List the devices in your organization, such as every unassigned Mac or the iPhones added this week. Leave the filters empty for all.

Inputs

Serial numbersserial_numberslist
Only these devices. Leave empty for any.
Kinds of deviceproduct_familieslist
Only these kinds of device. Leave empty for any.One or more of: Mac, iPhone, iPad, iPod, AppleTV (Apple TV), Watch (Apple Watch), Vision (Apple Vision Pro).
Bought frompurchase_sourceslist
Only devices from these sources. Leave empty for any.One or more of: APPLE (Bought from Apple), RESELLER (Bought from a reseller or carrier), MANUALLY_ADDED (Added by hand (Apple Configurator)).
Assignmentassignment_statustext
Only devices that are, or aren't, assigned to a device management service. Leave empty for both.One of: ASSIGNED (Assigned to a device management service), UNASSIGNED (Not assigned).
Order numbersorder_numberslist
Only devices from these orders. Leave empty for any.
Added on or afteradded_afterdate and time
Only devices added to the organization from this time.
Added beforeadded_beforedate and time
Only devices added to the organization before this time.
Maximum resultslimitnumber
The most devices to return, up to 5000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many
deviceslist
The devices
has_moretrue/false
True if there were more than the maximum asked for
Example output
{
  "count": 1,
  "devices": [
    {
      "addedToOrgDateTime": "2026-10-30T22:05:14.192Z",
      "bluetoothMacAddress": "a4:83:e7:12:34:57",
      "color": "SPACE GRAY",
      "deviceCapacity": "512GB",
      "deviceModel": "MacBook Pro 14-inch",
      "eid": null,
      "ethernetMacAddress": [],
      "id": "C02X1234ABCD",
      "imei": [],
      "isMdmMigrationCapable": true,
      "mdmMigrationDeadlineDateTime": null,
      "mdmMigrationStatus": null,
      "meid": [],
      "orderDateTime": "2026-10-28T07:00:00Z",
      "orderNumber": "W1234567890",
      "partNumber": "MTL73LL/A",
      "productFamily": "Mac",
      "productType": "Mac15,3",
      "purchaseSourceId": "1234567",
      "purchaseSourceType": "APPLE",
      "releasedFromOrgDateTime": null,
      "serialNumber": "C02X1234ABCD",
      "status": "ASSIGNED",
      "updatedDateTime": "2026-11-01T15:33:54.164Z",
      "wifiMacAddress": "a4:83:e7:12:34:56"
    }
  ],
  "has_more": false
}

List devices assigned to a service

List the serial numbers of the devices assigned to a device management service.

Inputs

Device management serviceservice_idtextRequired
The device management service (MDM server). Pick one, or give its ID from an earlier step.
Maximum resultslimitnumber
The most devices to return, up to 5000. Defaults to 5000.From 1 to 5000.

Outputs

countnumber
How many
has_moretrue/false
True if there were more than the maximum asked for
serial_numberslist
The devices' serial numbers
service_idtext
The service
Example output
{
  "count": 1,
  "has_more": false,
  "serial_numbers": [
    "C02X1234ABCD"
  ],
  "service_id": "1F97349736CF4614A94F624E705841AD"
}

List users

List the people in your organization, with their Managed Apple Account, department, job title and status.

Inputs

Maximum resultslimitnumber
The most users to return, up to 5000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many
has_moretrue/false
True if there were more than the maximum asked for
userslist
The users
Example output
{
  "count": 1,
  "has_more": false,
  "users": [
    {
      "costCenter": "CC100",
      "createdDateTime": "2026-01-10T10:30:00Z",
      "department": "IT",
      "division": "Operations",
      "email": "jo.rivera@example.com",
      "employeeNumber": "EMP001",
      "firstName": "Jo",
      "id": "1234567890",
      "isExternalUser": false,
      "jobTitle": "Support Specialist",
      "lastName": "Rivera",
      "managedAppleAccount": "jo.rivera@appleid.example.com",
      "middleName": null,
      "phoneNumbers": [
        {
          "phoneNumber": "+1-555-123-4567",
          "type": "WORK"
        }
      ],
      "roleOuList": [
        {
          "ouId": "OU123456",
          "roleName": "Staff"
        }
      ],
      "startDateTime": "2026-01-15T08:00:00Z",
      "status": "ACTIVE",
      "updatedDateTime": "2026-06-01T14:22:00Z"
    }
  ]
}

Move devices to another service

Assign enrolled devices to a new device management service and have them move to it without being erased, by a deadline up to 90 days away.

Inputs

Device management serviceservice_idtextRequired
The device management service (MDM server). Pick one, or give its ID from an earlier step.
Devicesserial_numberslistRequired
The devices to move. Pick them, or give serial numbers.
Deadlinedeadlinedate and timeRequired
When the devices must have moved by, up to 90 days from now.

Outputs

activity_idtext
The activity's ID, for 'Get device activity'
completedtext
When it finished (ISO 8601)
createdtext
When it started (ISO 8601)
is_donetrue/false
Whether it has finished
log_urltext
A link to its log (a CSV file), once it has finished
serial_numberslist
The devices' serial numbers
statustext
COMPLETED, IN_PROGRESS, STOPPED or FAILED
sub_statustext
The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
succeededtrue/false
Whether it finished with every device done
Example output
{
  "activity_id": "b1481656-b267-480d-b284-a809eed8b041",
  "completed": null,
  "created": "2026-11-05T04:15:43.282Z",
  "is_done": false,
  "log_url": null,
  "serial_numbers": [
    "C02X1234ABCD"
  ],
  "status": "IN_PROGRESS",
  "sub_status": "SUBMITTED",
  "succeeded": false
}

Release devices from the organization

Permanently release devices from your organization, such as ones sold or given away. They lose their enrollment assignment and leave Blueprints, and can't be added back without the seller.

Inputs

Devicesserial_numberslistRequired
The devices to release. Pick them, or give serial numbers.

Outputs

activity_idtext
The activity's ID, for 'Get device activity'
completedtext
When it finished (ISO 8601)
createdtext
When it started (ISO 8601)
is_donetrue/false
Whether it has finished
log_urltext
A link to its log (a CSV file), once it has finished
serial_numberslist
The devices' serial numbers
statustext
COMPLETED, IN_PROGRESS, STOPPED or FAILED
sub_statustext
The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
succeededtrue/false
Whether it finished with every device done
Example output
{
  "activity_id": "b1481656-b267-480d-b284-a809eed8b041",
  "completed": null,
  "created": "2026-11-05T04:15:43.282Z",
  "is_done": false,
  "log_url": null,
  "serial_numbers": [
    "C02X1234ABCD"
  ],
  "status": "IN_PROGRESS",
  "sub_status": "SUBMITTED",
  "succeeded": false
}

Remove devices from a Blueprint

Remove devices from a Blueprint.

Inputs

Blueprintblueprint_idtextRequired
The Blueprint. Pick one, or give its ID from an earlier step.
Devicesserial_numberslistRequired
The devices to remove. Pick them, or give serial numbers.

Outputs

blueprint_idtext
The Blueprint
countnumber
How many
serial_numberslist
The devices' serial numbers
Example output
{
  "blueprint_id": "blueprint-12345",
  "count": 1,
  "serial_numbers": [
    "C02X1234ABCD"
  ]
}

Unassign devices from a service

Unassign devices from a device management service. Apple does this in the background; 'Get device activity' says when it is done.

Inputs

Device management serviceservice_idtextRequired
The device management service (MDM server). Pick one, or give its ID from an earlier step.
Devicesserial_numberslistRequired
The devices to unassign. Pick them, or give serial numbers.

Outputs

activity_idtext
The activity's ID, for 'Get device activity'
completedtext
When it finished (ISO 8601)
createdtext
When it started (ISO 8601)
is_donetrue/false
Whether it has finished
log_urltext
A link to its log (a CSV file), once it has finished
serial_numberslist
The devices' serial numbers
statustext
COMPLETED, IN_PROGRESS, STOPPED or FAILED
sub_statustext
The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
succeededtrue/false
Whether it finished with every device done
Example output
{
  "activity_id": "b1481656-b267-480d-b284-a809eed8b041",
  "completed": null,
  "created": "2026-11-05T04:15:43.282Z",
  "is_done": false,
  "log_url": null,
  "serial_numbers": [
    "C02X1234ABCD"
  ],
  "status": "IN_PROGRESS",
  "sub_status": "SUBMITTED",
  "succeeded": false
}

On this page