API Guides

Welcome to the BuildingMinds API reference, your key to a comprehensive understanding of our API.

This API allows efficient communication and integration between your application and the BM platform. It allows you to onboard your application's data into the BM platform and receive updates regarding the status of your data's integration into our platform. The API follows the OpenAPI 3.0.0 specification, ensuring a standardized and easy-to-understand structure.

Conventions

All API requests should be directed to the base URL https://api.onbuildingminds.com/api/digitaltwinintegration. It's mandatory to use HTTPS for all API interactions.

The BM API is designed around RESTful principles where feasible, with actions carried out through GET, POST, and DELETE requests. Both request and response bodies are formatted in JSON.