Skip to main content

Casambi REST API

Overview​

Casambi Restful API is used for accessing persistent Casambi bluetooth mesh network information from Casambi cloud services. This kind of information does not change very often and in most cases is tied to configuration of related network, luminaires and devices.

API Base URL: https://door.casambi.com

To gain access to Casambi WebSocket (and its events) use of information like session id and network id received from REST API are required.

note

  • Event information reveiced from the WebSocket is supplementing the information received from the REST API and in some parts may overlap.

  • All GET request parameter values (URL query parameters) must be URL encoded.

Version History​

  • /v1 Create network/Casambi user sessions and request network-related information.

Recent Changes​

  • 13.05.2020 - Datapoints request updated to use string-based data type filter values; int-based sensor type values are deprecated
  • 07.12.2020 - Datapoints support timezone offset parameter and ISO 8601 formatted time range parameters
  • 16.12.2020 - Renamed mac property to address for clarity
  • 04.03.2021 - Added CURL request examples and Datalogging documentation
  • 15.08.2021 - Added XmlHttp JavaScript code examples; navigation split to sections
  • 01.12.2022 - Added new Datapoint query endpoint; deprecated old version
  • 22.03.2023 - Response now indicates availability of more data on server
  • 04.09.2024 - Deprecated Datapoint query endpoint (v1) is no longer available
  • 06.01.2026 - Added API endpoint for creating network session for given network entity ID
  • 07.01.2026 - Added API endpoint for creating network session set from network entity ID list