Get Real-time Desk Occupancy for a Floor

This API returns the desk occupancy for all desk sensors on a floor.

For the sensors to report occupancy data, you will need licenses based on the number of sensors. You will need to purchase Sensor and API licenses to get real-time desk occupancy for all desks on a floor. Refer to the License Types and Product Codes.   

Also, before using this API call, ensure that all desk sensors are assigned to 'Desk Sensor' Fixture Type. See article Enable Desk Sensors to assign 'Desk Sensor' Fixture Type to sensors. 


GET https://{em_ip_address_or_hostname}/ems/api/org/sensor/v1/getDeskOccupancyState/list/floor/{floor_id}



em_ip_address or hostname

Manage’s IP address or hostname


Floor identifier. Use the Floor ID returned in the Get All Floors API, or in Manage, select Facility > Floor in the left panel, and click the Settings tab to see the Floor ID.



The fixture or sensor identifier. 


Sensor name.


0 – Desk Unoccupied

1 – Desk Occupied

-1 – Fault. Sensors are not reporting occupancy


Sample Code

For example, if Floor 1 has three desk sensors, the occupancy status for all three desk sensors on Floor 1 is returned.


HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
    "deskSensor": [
            "id": "70",
            "name": "Sensor71bd6a",
            "occupancyState": "0"
            "id": "71",
            "name": "Sensor71af2a",
            "occupancyState": "0"
            "id": "72",
            "name": "Sensor71b13e",
            "occupancyState": "1"
Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request


Article is closed for comments.