v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
device_Device

Retrieve detailed device information.

Retrieves comprehensive details for a single enrolled device by UUID, using the V2 device schema.

Returns a V2 platform-typed device record with richer fields than the v0 equivalent, for all supported Esper-managed platforms.

About Get Device Details (V2)

This is the recommended endpoint for single-device lookups in new integrations. The V2 device schema provides additional fields compared to the v0 schema and aligns with the richer data model returned by /api/v2/devices/. Like the list endpoint, the response is polymorphic — the exact fields depend on the device platform.

Key Fields

id (path) — Esper device UUID (required)

Common Use Cases

Fetching full device context before constructing a pipeline or operation

Retrieving V2-specific fields like Foundry OS version, Esper agent version, or lock-down state

Integrating device data into external ITSM, asset management, or monitoring systems

Best Practices

Prefer this over /api/device/v0/devices/{id}/ for all new integrations

Inspect the platform field to determine which V2 schema variant applies before parsing

Use the heartbeat endpoints for lightweight connectivity checks rather than polling this endpoint

get/v2/devices/{id}

Path parameters

idstring uuid required

ID of the device

Response

Detailed information of the device

codeinteger
messagestring