List sensorDevices

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a list of all workplace sensor devices created for a tenant.

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) PlaceDevice.Read.All PlaceDevice.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application PlaceDevice.Read.All PlaceDevice.ReadWrite.All

HTTP request

GET /workplace/sensorDevices

Optional query parameters

This method supports the $filter, $top, $select, and $skipToken OData query parameters to help customize the response. You can use $filter on the deviceId, displayName, description, macAddress, manufacturer, ipV4Address, ipV6Address, and tags properties.

Supported query patterns

Pattern Syntax Notes
Server-side pagination @odata.nextLink You get a continuation token in the response, when a result set spans multiple pages.
Filter /workplace/sensorDevices?$filter=Tags/Any(x: cast(x, 'String') eq 'Building A') Filter devices based on the tags.
Filter /workplace/sensorDevices?$filter=cast(manufacturer, 'String') eq 'Contoso' Filter devices based on the manufacturer of the device.
Filter /workplace/sensorDevices?$filter=cast(deviceId, 'String') eq 'contoso_9D6816' Filter devices based on the user provided device identifier.
Page limit /workplace/sensorDevices?$top=20 Get devices with a page size of 20. The default page size is 10.

Request headers

Name Description
Authorization 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 a collection of workplaceSensorDevice objects in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/workplace/sensorDevices

Response

The following example shows the response.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices",
    "@odata.nextLink": "https://graph.microsoft.com/beta/workplace/sensorDevices?$top=1&$skiptoken=aHR0cHM6Ly9vdXRsb29rLXNkZi5vZmZpY2UuY29tL2FwaS92Mi4wL09yZ1BhcnRpdGlvbnMoJ0FwcDpQbGFjZXNEZXZpY2VzXzIxNmFlZThkLTNjYzgtNDJhYi1hYmU4LTM0ZGRhZTE1MWI3M0BkNzQ4NTRiNy0zZjFjLTRlM2MtYjJlYy1kOTZlMDY3ZWEwYTYnKS9DdXJyZW50Q29sbGVjdGlvbnMoJ0RldmljZXNDb2xsZWN0aW9uJykvSXRlbXM%2fJTI0dG9wPTEmJTI0c2tpcHRva2VuPU15WlJWa1pDVVZWR1FsRlZSWFpNZVRoMlRIazRka3g1T0haUFJVcENVVlZHUWxOR1RYWldNVnB1WWpBNVFrMUZkRlZTYmxKU1pHcENXV0V6UlRCa2VqQTU%3d",
    "value": [
        {
            "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7",
            "deviceId": "contoso_9D6816",
            "displayName": "Contoso 9D6816 Device",
            "description": "Contoso 9D6816 Device",
            "macAddress": "00:0A:95:9D:68:16",
            "manufacturer": "Contoso",
            "ipV4Address": "192.168.1.100",
            "ipV6Address": "2001:db8::ff00:42:8329",
            "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671",
            "tags": [
                "Building A",
                "Floor 3",
                "Room 301",
                "Conference Room"
            ],
            "sensors": [
                {
                    "sensorId": "Occupancy",
                    "displayName": null,
                    "sensorType": "occupancy",
                    "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671"
                },
                {
                    "sensorId": "PeopleCount",
                    "displayName": null,
                    "sensorType": "peopleCount",
                    "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671"
                }
            ]
        }
    ]
}