v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
device_onboarding_DEP Sync Request

List all DEP sync requests for the tenant

⚠️ Apple devices only. DEP (Device Enrollment Program) is an Apple provisioning technology, now part of Apple Business Manager.

Retrieves a paginated list of all DEP sync requests for the tenant, including each request's status and any device-level failure details.

About List DEP Sync Requests

Apple's Device Enrollment Program (DEP), accessed through Apple Business Manager, assigns managed devices to an MDM server. A DEP sync request triggers Esper to pull the latest device assignments from Apple's DEP service, ensuring that newly enrolled or reassigned Apple devices are reflected in the tenant. Each DEPSyncRequestForGetResponse record includes the request's lifecycle status (QUEUED, INPROGRESS, COMPLETE, SUCCESS, or FAILURE), the user or service that created the request (created_by), and the timestamps for when the request was created and last updated. On failure, a failure_reason and a devices object may contain details about specific devices that failed to sync. Use POST /api/onboarding/v0/depsyncs/ to trigger a new sync, and GET /api/onboarding/v0/depsyncs/{id}/ to retrieve a specific request.

Key Response Fields

id — DEP sync request UUID

status — QUEUED, INPROGRESS, COMPLETE, SUCCESS, or FAILURE

failure_reason — High-level reason for sync failure (present on FAILURE status)

devices.failure — Array of {serial, reason} objects for devices that failed to process

created_by — User who triggered the sync

created_at / updated_at — Timestamps

Common Use Cases

Reviewing the history of DEP sync operations to confirm when devices were last successfully synced from Apple

Identifying which specific devices failed in a DEP sync and why

Auditing DEP sync activity for compliance or onboarding reporting

Best Practices

On FAILURE status, inspect both failure_reason for the overall cause and devices.failure for per-device detail — they may differ

Paginate with limit and offset for tenants with a long sync history

get/onboarding/v0/depsyncs/

Response

DEP sync request list for the Tenant

codeinteger
messagestring