Microsoft Dynamics NAV Companies API

Manage automation companies

GitHub OpenAPI

Operations 6

GET /companies List Companies #
GET /companies({company_id})/automationCompanies List Automation Companies #
POST /companies({company_id})/automationCompanies Create a Company #
GET /companies({company_id})/automationCompanies({automationCompany_id}) Get an Automation Company #
PATCH /companies({company_id})/automationCompanies({automationCompany_id}) Update an Automation Company #
DELETE /companies({company_id})/automationCompanies({automationCompany_id}) Delete an Automation Company #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/navision:navision-companies-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

navision-companies-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Business Central Automation API v2.0 Companies API
  description: API for automating company setup and tenant management in Dynamics 365 Business Central. Supports creating companies, installing and managing extensions, assigning permission sets to users, uploading and applying RapidStart packages, managing user groups and security groups, and activating features programmatically.
  version: '2.0'
  contact:
    name: Microsoft Dynamics Support
    email: bcsupport@microsoft.com
    url: https://dynamics.microsoft.com/support/
  license:
    name: Microsoft APIs Terms of Use
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
  termsOfService: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
servers:
- url: https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0
  description: Business Central Online Automation API
  variables:
    environment:
      default: production
      description: The name of the Business Central environment
- url: https://{server}:{port}/{instance}/api/microsoft/automation/v2.0
  description: Business Central On-Premises Automation API
  variables:
    server:
      default: localhost
      description: The on-premises server hostname
    port:
      default: '7048'
      description: The OData services port
    instance:
      default: BC
      description: The Business Central server instance name
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Companies
  description: Manage automation companies
paths:
  /companies:
    get:
      summary: List Companies
      description: Returns a list of companies available for automation.
      operationId: listCompanies
      tags:
      - Companies
      responses:
        '200':
          description: Successfully retrieved companies
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company'
              examples:
                Listcompanies200Example:
                  summary: Default listCompanies 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      name: Example Title
                      displayName: example_value
                      businessProfileId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /companies({company_id})/automationCompanies:
    get:
      summary: List Automation Companies
      description: Returns a list of automation company objects.
      operationId: listAutomationCompanies
      tags:
      - Companies
      parameters:
      - $ref: '#/components/parameters/company_id'
      responses:
        '200':
          description: Successfully retrieved automation companies
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/AutomationCompany'
              examples:
                Listautomationcompanies200Example:
                  summary: Default listAutomationCompanies 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      name: Example Title
                      displayName: example_value
                      businessProfileId: '500123'
                      evaluationCompany: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Create a Company
      description: Creates a new company in the Business Central tenant.
      operationId: createAutomationCompany
      tags:
      - Companies
      parameters:
      - $ref: '#/components/parameters/company_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationCompanyCreate'
            examples:
              CreateautomationcompanyRequestExample:
                summary: Default createAutomationCompany request
                x-microcks-default: true
                value:
                  name: Example Title
                  displayName: example_value
                  businessProfileId: '500123'
      responses:
        '201':
          description: Company created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationCompany'
              examples:
                Createautomationcompany201Example:
                  summary: Default createAutomationCompany 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    displayName: example_value
                    businessProfileId: '500123'
                    evaluationCompany: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /companies({company_id})/automationCompanies({automationCompany_id}):
    get:
      summary: Get an Automation Company
      description: Retrieves a specific automation company by ID.
      operationId: getAutomationCompany
      tags:
      - Companies
      parameters:
      - $ref: '#/components/parameters/company_id'
      - name: automationCompany_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '200':
          description: Successfully retrieved automation company
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationCompany'
              examples:
                Getautomationcompany200Example:
                  summary: Default getAutomationCompany 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    displayName: example_value
                    businessProfileId: '500123'
                    evaluationCompany: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: Update an Automation Company
      description: Updates properties of an automation company (e.g., rename).
      operationId: updateAutomationCompany
      tags:
      - Companies
      parameters:
      - $ref: '#/components/parameters/company_id'
      - name: automationCompany_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: '500123'
      - $ref: '#/components/parameters/ifMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationCompanyUpdate'
            examples:
              UpdateautomationcompanyRequestExample:
                summary: Default updateAutomationCompany request
                x-microcks-default: true
                value:
                  name: Example Title
                  displayName: example_value
      responses:
        '200':
          description: Company updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationCompany'
              examples:
                Updateautomationcompany200Example:
                  summary: Default updateAutomationCompany 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    displayName: example_value
                    businessProfileId: '500123'
                    evaluationCompany: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: Delete an Automation Company
      description: Deletes a company from the tenant.
      operationId: deleteAutomationCompany
      tags:
      - Companies
      parameters:
      - $ref: '#/components/parameters/company_id'
      - name: automationCompany_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '204':
          description: Company deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    AutomationCompanyUpdate:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        displayName:
          type: string
          example: example_value
    AutomationCompany:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: abc123
        name:
          type: string
          description: The company name
          example: Example Title
        displayName:
          type: string
          description: The company display name
          example: example_value
        businessProfileId:
          type: string
          description: The business profile ID
          example: '500123'
        evaluationCompany:
          type: boolean
          description: Whether this is an evaluation company
          example: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          example: example_value
    Company:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: abc123
        name:
          type: string
          example: Example Title
        displayName:
          type: string
          example: example_value
        businessProfileId:
          type: string
          example: '500123'
    AutomationCompanyCreate:
      type: object
      required:
      - name
      - displayName
      properties:
        name:
          type: string
          description: The name of the new company
          example: Example Title
        displayName:
          type: string
          description: The display name of the new company
          example: example_value
        businessProfileId:
          type: string
          example: '500123'
  responses:
    BadRequest:
      description: Bad request - invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized - authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    company_id:
      name: company_id
      in: path
      required: true
      description: The unique identifier of the company
      schema:
        type: string
        format: uuid
    ifMatch:
      name: If-Match
      in: header
      required: true
      description: ETag value for optimistic concurrency control
      schema:
        type: string
    skip:
      name: $skip
      in: query
      description: Number of items to skip
      schema:
        type: integer
        minimum: 0
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to include in the response
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 0
    filter:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication via Microsoft Entra ID
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://api.businesscentral.dynamics.com/.default: Access Business Central Automation APIs
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://api.businesscentral.dynamics.com/.default: Access Business Central Automation APIs
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Automation API Documentation
  url: https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/itpro-introduction-to-automation-apis