Get all DEP tokens

⚠️ iOS/iPadOS/tvOS only.

Returns a paginated list of all DEP tokens registered to the Esper tenant, with optional filtering by token state.

Use this endpoint to audit DEP token status across the tenant, identify tokens pending completion, and retrieve id values needed for upload or individual retrieval operations.

About List DEP Tokens

DEP tokens are credentials that authorize Esper to communicate with Apple Business Manager for automatic iOS device enrollment. Each token progresses through two states. CSR_GENERATED (the Esper public key has been generated but the ABM server token has not yet been uploaded) and COMPLETED (the full token exchange is done and the integration is active). A tenant may have multiple DEP tokens, each corresponding to a different ABM MDM server entry or Apple Business location.

Key Fields / Query Parameters

state (query, optional) — Filter results by token state-- CSR_GENERATED or COMPLETED.

id — UUID of the DEP token record; used in GET /api/tenant/v0/deptokens/{id}/ and PUT /api/tenant/v0/deptokens/{id}/.

token_name — Human-readable label assigned to the token during upload.

meta.token_expiry_on — Expiry date of the DEP token; tokens expire annually and must be renewed.

Common Use Cases

Auditing all DEP tokens to identify any CSR_GENERATED records that represent incomplete setup flows

Monitoring token expiry dates ahead of the annual renewal window

Retrieving token id values to pass to the individual token endpoints

Best Practices

Filter by state=CSR_GENERATED periodically to surface abandoned token setup flows that were started but never completed.

Track meta.token_expiry_on across all tokens; expired DEP tokens prevent automatic enrollment of new iOS devices.

Use the returned id values to fetch full details via GET /api/tenant/v0/deptokens/{id}/ before performing uploads or updates.