{"title":"API endpoint structure","url":"https://jonas-paprotka.de/docs/dev-itpro/webservices/api-endpoint-structure/","by":"JOP-AL","license":"Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/webservices/api-endpoint-structure, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/webservices/api-endpoint-structure","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"Discover the base URL pattern and environment details required to access Business Central API endpoints.","date":"2025-07-07","meta":{"topic":"overview"},"outline":[{"level":2,"title":"The structure of API endpoint URLs","slug":"the-structure-of-api-endpoint-urls","at":239,"chars":2866},{"level":3,"title":"Base URL","slug":"base-url","at":389,"chars":371},{"level":3,"title":"Environment information","slug":"environment-information","at":760,"chars":2025},{"level":3,"title":"Company","slug":"company","at":2785,"chars":320},{"level":2,"title":"Example: URLs for Business Central Standard API","slug":"example-urls-for-business-central-standard-api","at":3105,"chars":267},{"level":2,"title":"Example: URLs for Business Central automation API","slug":"example-urls-for-business-central-automation-api","at":3372,"chars":338},{"level":2,"title":"Example: URLs for a custom API","slug":"example-urls-for-a-custom-api","at":3710,"chars":492},{"level":2,"title":"Related information","slug":"related-information","at":4202,"chars":105}],"text":"Business Central exposes many APIs that make it possible for other services to integrate with Business Central. This article explains how the endpoint URLs for these APIs are constructed and provides examples from different types of APIs.\n## The structure of API endpoint URLs\nURLs for built-in or custom API endpoints all follow the same base pattern. They start with the following base.\n### Base URL\n```text\nhttps://api.businesscentral.dynamics.com/v2.0\n```\nThe v2.0 part of the base URL stems from the time when Business Central started supporting multiple environments.\nNext, the URL needs to include, which Business Central environment to connect to. Here, you can choose to include the Microsoft Entra ID of the tenant you want to connect to in the URL:\n### Environment information\n```text\n{Base URL}/{Entra ID}/{Environment name}\n\nor\n\n{Base URL}/{Environment name}\n```\nThen, you need to specify that the endpoint is for an API object (API page or API query). Notice that this part of the URL is different for other technologies, such as OData web services. This article doesn't cover these cases, as APIs are the recommended way of integrating Business Central with other systems.\n```text\n{Base URL}/{Environment information}/api\n```\nAfter that, you need to specify the API route (also called API category). For partner-created APIs, the API route is constructed using the APIPublisher, APIGroup, and APIVersion that you specify in your API object in AL. See aka.ms/BCCustomAPI<https://aka.ms/bccustomapi>.\n> TIP\n> Use the API Overview page in Business Central to explore published API pages, API queries, and API codeunits that are available in your environment. Learn more about the API Overview page in Discover APIs with the API Overview page</api-overview?toc=/dynamics365/business-central/dev-itpro/toc.json>.\nEvery Business Central environment comes with a standard set of commonly used APIs; for these, the API route is simply an APIVersion (namely v2.0), with no group or publisher.\nAPI route For Microsoft Standard API, use this path:\n```text\n{Base URL}/{Environment information}/api/v2.0\n```\nOther endpoints include API publisher, API group, and API version:\n```text\n{Base URL}/{Environment information}/api/{API publisher}/{API group}/{API version}\n```\nThe resulting URL points at the root of the APIs for the specific combination of parameters you used; in other words, this URL points at the OData Service Document. You have to append the specific endpoint to the URL to be able to access your data.\n```text\nEndpoint {Base URL}/{Environment information}/api/{API route}/{endpoint}\n```\nTo call most of the Business Central endpoints, you need to specify, which company you want to connect to. You can specify the company as part of the URL or as a query parameter.\n### Company\nYou can specify the company as a query parameter:\n```text\n{Base URL}/{Environment information}/api/{API route}/{endpoint}?company=<companyGuid>\n```\nAlternatively, you can specify it as part of the endpoint:\n```text\n{Base URL}/{Environment information}/api/{API route}/companies(<companyGuid>)/{endpoint}\n```\n## Example: URLs for Business Central Standard API\nTo access any endpoint from the Microsoft Standard API 2.0, use this URL\n`https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/v2.0/{endpoint}`\nSee Business Central API (v2.0)<../api-reference/v2.0>.\n## Example: URLs for Business Central automation API\nTo access any endpoint from the Business Central automation API, use this URL\n`https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/microsoft/automation/v2.0/companies({companyId})/{endpoint}`\nSee Automation API<../administration/itpro-introduction-to-automation-apis>\n## Example: URLs for a custom API\nAssume you have a custom API with the following API metadata\n```al\npage 50101 \"myAPIPage\"\n{\n    PageType = API;\n\n    APIVersion = 'v1.0';\n    APIPublisher = 'myPublisher';\n    APIGroup = 'myGroup';\n\n// endpoint defined here\n}\n```\nTo access the endpoint from that API, use the following URL:\n`https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/{API publisher}/{API group}/{API version}/{endpoint}`\nSee ../developer/devenv-develop-custom-api\n## Related information\napi-overview\nWeb services overview<web-services>\n../developer/integration-overview"}