WebConnector REST API

Note

The REST API is only supported for BC versions starting from Business Central 2023 Release Wave 1 (abbreviated as BC22) or later. If you are using an older version of Business Central, Dynamics 365 NAV or Navision, please have a look at our SOAP API.

Introduction

Web Connector's suite of services has evolved to incorporate the REST API, designed specifically with Microsoft Dynamics 365 Business Central in mind. While the SOAP API established the foundational integration capabilities, the RESTful interface introduces a modern, stateless communication standard for more streamlined and efficient interactions. Similar to our SOAP-based services, a significant portion of our RESTful offerings are grounded on the standard Create, Read, Update, and Delete (CRUD) operations. This empowers businesses to flexibly interact with their data within Business Central. Recognizing the distinct advantages and diverse scenarios that the REST API caters to, customizing these services might sometimes be critical to achieving optimized user experiences. As we delve deeper, you'll discover elaborate message formats, real-world usage illustrations, and essential attributes that foster effortless assimilation and utilization of the WebConnector REST API.

Performance Hints ⚡

Learn more about the web service performance in this article.

Based on Microsoft Services

Our API development is based on the API endpoints already provided by Microsoft. These Microsoft endpoints are available in every Business Central installation and can be used in addition to the WebConnector and KatarGo endpoints. If we use Microsoft endpoints, we also reference the Microsoft documentation. You can find the complete documentation for all Microsoft endpoints here.