API Builder
Build an API in four steps
Turn a Business Central table into an API page or a read-only API query in four steps, test it, and copy a request for Postman, Power Automate or curl.
updated: applies-to: 1.0.0.0
The API Builder turns a table into a working API.
Open it
Choose the API Builder tile, New API in the role center, or New API in the Object Designer. The APIs tile lists the APIs you made.
The four steps
- Table. Choose the table and the designer extension that will hold the API.
- Fields. Tick the fields, or choose Suggested Fields.
- Names. Accept or change the names and the endpoint, choose API page or API query (read only), and choose Create.
- Done. Choose Test, Copy for Postman, Copy for Power Automate, or Open in Object Designer to publish it.
Test
Test shows the JSON the API returns. Until the extension is published it shows a preview built from your own data. After publishing, an administrator can choose in Set Up Test Authentication how Test calls the live endpoint: no web call, Basic, or Microsoft Entra client credentials. A live test reads up to five records.
On the APIs list
- Copy Endpoint and Copy as curl give you the URL and a ready request.
- Test runs the test again.
- Open in Object Designer opens the extension that holds the API.
TIP
Publish the extension from the Object Designer before you give the endpoint to anyone. See Check, publish and deploy.