# Apple Business

> 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.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/apple-business-manager

## Actions

### Add devices to a Blueprint

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

**Inputs**

- Blueprint (`blueprint_id`, text, required): The Blueprint. Pick one, or give its ID from an earlier step.
- Devices (`serial_numbers`, list, required): The devices to add. Pick them, or give serial numbers.

**Outputs**

- `blueprint_id` (text): The Blueprint
- `count` (number): How many
- `serial_numbers` (list): The devices' serial numbers

**Example output**

```json
{
  "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 service (`service_id`, text, required): The device management service (MDM server). Pick one, or give its ID from an earlier step.
- Devices (`serial_numbers`, list, required): The devices to assign. Pick them, or give serial numbers.

**Outputs**

- `activity_id` (text): The activity's ID, for 'Get device activity'
- `completed` (text): When it finished (ISO 8601)
- `created` (text): When it started (ISO 8601)
- `is_done` (true/false): Whether it has finished
- `log_url` (text): A link to its log (a CSV file), once it has finished
- `serial_numbers` (list): The devices' serial numbers
- `status` (text): COMPLETED, IN_PROGRESS, STOPPED or FAILED
- `sub_status` (text): The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
- `succeeded` (true/false): Whether it finished with every device done

**Example output**

```json
{
  "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**

- Devices (`serial_numbers`, list, required): The devices whose move to cancel. Pick them, or give serial numbers.

**Outputs**

- `activity_id` (text): The activity's ID, for 'Get device activity'
- `completed` (text): When it finished (ISO 8601)
- `created` (text): When it started (ISO 8601)
- `is_done` (true/false): Whether it has finished
- `log_url` (text): A link to its log (a CSV file), once it has finished
- `serial_numbers` (list): The devices' serial numbers
- `status` (text): COMPLETED, IN_PROGRESS, STOPPED or FAILED
- `sub_status` (text): The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
- `succeeded` (true/false): Whether it finished with every device done

**Example output**

```json
{
  "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**

- Device (`serial_number`, text, required): The device. Pick one, or give its serial number from an earlier step.

**Outputs**

- `is_locked` (true/false): Whether it is locked
- `lock_type` (text): MDM, USER or NONE
- `serial_number` (text): The device's serial number

**Example output**

```json
{
  "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**

- Device (`serial_number`, text, required): The device. Pick one, or give its serial number from an earlier step.

**Outputs**

- `count` (number): How many
- `coverages` (list): Its coverages
- `has_active_coverage` (true/false): Whether any coverage is active
- `serial_number` (text): The device's serial number

**Example output**

```json
{
  "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**

- Device (`serial_number`, text, required): The device. Pick one, or give its serial number from an earlier step.

**Outputs**

- `device` (object): The device

**Example output**

```json
{
  "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 ID (`activity_id`, text, required): The activity_id an earlier assign, unassign or release step returned.

**Outputs**

- `activity_id` (text): The activity's ID, for 'Get device activity'
- `completed` (text): When it finished (ISO 8601)
- `created` (text): When it started (ISO 8601)
- `is_done` (true/false): Whether it has finished
- `log_url` (text): A link to its log (a CSV file), once it has finished
- `status` (text): COMPLETED, IN_PROGRESS, STOPPED or FAILED
- `sub_status` (text): The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
- `succeeded` (true/false): Whether it finished with every device done

**Example output**

```json
{
  "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 service (`service_id`, text, required): The device management service (MDM server). Pick one, or give its ID from an earlier step.

**Outputs**

- `service` (object): The service

**Example output**

```json
{
  "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**

- Device (`serial_number`, text, required): The device. Pick one, or give its serial number from an earlier step.

**Outputs**

- `is_assigned` (true/false): Whether it is assigned to one
- `serial_number` (text): The device's serial number
- `service` (object): The service, if it is assigned

**Example output**

```json
{
  "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**

- User (`account_user_id`, text, required): The person. Pick one, or give their ID from an earlier step.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "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**

- From (`start_time`, date and time, required): The start of the period.
- Until (`end_time`, date and time): The end of the period. Defaults to now.
- Event (`event_type`, text): 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_id`, text): Only events done by this user or API account ID.
- Done to (ID) (`subject_id`, text): Only events about this ID, such as a user's ID.
- Maximum results (`limit`, number): The most events to return, up to 5000. Defaults to 100. From 1 to 5000.

**Outputs**

- `count` (number): How many
- `events` (list): The events
- `has_more` (true/false): True if there were more than the maximum asked for

**Example output**

```json
{
  "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**

- `blueprints` (list): The Blueprints
- `count` (number): How many

**Example output**

```json
{
  "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**

- `count` (number): How many
- `services` (list): The services

**Example output**

```json
{
  "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 numbers (`serial_numbers`, list): Only these devices. Leave empty for any.
- Kinds of device (`product_families`, list): 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 from (`purchase_sources`, list): 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)).
- Assignment (`assignment_status`, text): 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 numbers (`order_numbers`, list): Only devices from these orders. Leave empty for any.
- Added on or after (`added_after`, date and time): Only devices added to the organization from this time.
- Added before (`added_before`, date and time): Only devices added to the organization before this time.
- Maximum results (`limit`, number): The most devices to return, up to 5000. Defaults to 100. From 1 to 5000.

**Outputs**

- `count` (number): How many
- `devices` (list): The devices
- `has_more` (true/false): True if there were more than the maximum asked for

**Example output**

```json
{
  "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 service (`service_id`, text, required): The device management service (MDM server). Pick one, or give its ID from an earlier step.
- Maximum results (`limit`, number): The most devices to return, up to 5000. Defaults to 5000. From 1 to 5000.

**Outputs**

- `count` (number): How many
- `has_more` (true/false): True if there were more than the maximum asked for
- `serial_numbers` (list): The devices' serial numbers
- `service_id` (text): The service

**Example output**

```json
{
  "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 results (`limit`, number): The most users to return, up to 5000. Defaults to 100. From 1 to 5000.

**Outputs**

- `count` (number): How many
- `has_more` (true/false): True if there were more than the maximum asked for
- `users` (list): The users

**Example output**

```json
{
  "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 service (`service_id`, text, required): The device management service (MDM server). Pick one, or give its ID from an earlier step.
- Devices (`serial_numbers`, list, required): The devices to move. Pick them, or give serial numbers.
- Deadline (`deadline`, date and time, required): When the devices must have moved by, up to 90 days from now.

**Outputs**

- `activity_id` (text): The activity's ID, for 'Get device activity'
- `completed` (text): When it finished (ISO 8601)
- `created` (text): When it started (ISO 8601)
- `is_done` (true/false): Whether it has finished
- `log_url` (text): A link to its log (a CSV file), once it has finished
- `serial_numbers` (list): The devices' serial numbers
- `status` (text): COMPLETED, IN_PROGRESS, STOPPED or FAILED
- `sub_status` (text): The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
- `succeeded` (true/false): Whether it finished with every device done

**Example output**

```json
{
  "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**

- Devices (`serial_numbers`, list, required): The devices to release. Pick them, or give serial numbers.

**Outputs**

- `activity_id` (text): The activity's ID, for 'Get device activity'
- `completed` (text): When it finished (ISO 8601)
- `created` (text): When it started (ISO 8601)
- `is_done` (true/false): Whether it has finished
- `log_url` (text): A link to its log (a CSV file), once it has finished
- `serial_numbers` (list): The devices' serial numbers
- `status` (text): COMPLETED, IN_PROGRESS, STOPPED or FAILED
- `sub_status` (text): The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
- `succeeded` (true/false): Whether it finished with every device done

**Example output**

```json
{
  "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**

- Blueprint (`blueprint_id`, text, required): The Blueprint. Pick one, or give its ID from an earlier step.
- Devices (`serial_numbers`, list, required): The devices to remove. Pick them, or give serial numbers.

**Outputs**

- `blueprint_id` (text): The Blueprint
- `count` (number): How many
- `serial_numbers` (list): The devices' serial numbers

**Example output**

```json
{
  "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 service (`service_id`, text, required): The device management service (MDM server). Pick one, or give its ID from an earlier step.
- Devices (`serial_numbers`, list, required): The devices to unassign. Pick them, or give serial numbers.

**Outputs**

- `activity_id` (text): The activity's ID, for 'Get device activity'
- `completed` (text): When it finished (ISO 8601)
- `created` (text): When it started (ISO 8601)
- `is_done` (true/false): Whether it has finished
- `log_url` (text): A link to its log (a CSV file), once it has finished
- `serial_numbers` (list): The devices' serial numbers
- `status` (text): COMPLETED, IN_PROGRESS, STOPPED or FAILED
- `sub_status` (text): The detailed status, such as SUBMITTED or COMPLETED_WITH_SUCCESS
- `succeeded` (true/false): Whether it finished with every device done

**Example output**

```json
{
  "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
}
```
