Get device

Namespace: microsoft.graph

Get the properties and relationships of a device object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Device.Read.All Directory.Read.All, Directory.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application Device.Read.All Directory.Read.All, Directory.ReadWrite.All

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Users
  • Directory Readers
  • Directory Writers
  • Compliance Administrator
  • Device Managers
  • Application Administrator
  • Security Reader
  • Security Administrator
  • Privileged Role Administrator
  • Cloud Application Administrator
  • Customer LockBox Access Approver
  • Dynamics 365 Administrator
  • Power BI Administrator
  • Desktop Analytics Administrator
  • Microsoft Managed Desktop Administrator
  • Teams Communications Administrator
  • Teams Communications Support Engineer
  • Teams Communications Support Specialist
  • Teams Administrator
  • Compliance Data Administrator
  • Security Operator
  • Kaizala Administrator
  • Global Reader
  • Directory Reviewer
  • Windows 365 Administrator

HTTP request

You can address the device using either its id or deviceId.

GET /devices/{id}
GET /devices(deviceId='{deviceId}')

Optional query parameters

This method supports the $select OData query parameter to help customize the response.

Request headers

Name Type Description
Authorization string Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and device object in the response body.

Examples

Example 1: Get a device

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/devices/000005c3-b7a6-4c61-89fc-80bf5ccfc366

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#devices/$entity",
  "@odata.id": "https://graph.microsoft.com/v2/72f988bf-86f1-41af-91ab-2d7cd011db47/directoryObjects/000005c3-b7a6-4c61-89fc-80bf5ccfc366/Microsoft.DirectoryServices.Device",
  "accountEnabled":false,
  "deviceId":"6fa60d52-01e7-4b18-8055-4759461fc16b",
  "displayName":"DESKTOP-858MANH",
  "id": "000005c3-b7a6-4c61-89fc-80bf5ccfc366",
  "operatingSystem":"Windows",
  "operatingSystemVersion":"10.0.19043.1165"
}

Example 2: Get a device and return only its id and extensionAttributes properties

Request

The following request retrieves the id and extensionAttributes property of a device.

GET https://graph.microsoft.com/beta/devices/6a59ea83-02bd-468f-a40b-f2c3d1821983?$select=id,extensionAttributes

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#devices(id,extensionAttributes)/$entity",
    "id": "6a59ea83-02bd-468f-a40b-f2c3d1821983",
    "extensionAttributes": {
        "extensionAttribute1": "BYOD-Device",
        "extensionAttribute2": null,
        "extensionAttribute3": null,
        "extensionAttribute4": null,
        "extensionAttribute5": null,
        "extensionAttribute6": null,
        "extensionAttribute7": null,
        "extensionAttribute8": null,
        "extensionAttribute9": null,
        "extensionAttribute10": null,
        "extensionAttribute11": null,
        "extensionAttribute12": null,
        "extensionAttribute13": null,
        "extensionAttribute14": null,
        "extensionAttribute15": null
    }
}