Microsoft Power Apps System API

openapi: 3.1.0
info:
  title: Microsoft Dataverse Web API (Power Apps) System API
  description: 'The Microsoft Dataverse Web API is a RESTful, OData v4 interface used by

    Power Apps and Dynamics 365 to interact with Dataverse data. This

    definition captures a representative subset of common operations

    (WhoAmI, table CRUD on accounts, $batch). The Web API base URL is

    organization-specific.

    Derived from https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/overview.

    '
  version: '9.2'
  contact:
    name: Microsoft Power Apps
    url: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/overview
servers:
- url: https://{organization}.crm.dynamics.com/api/data/v9.2
  description: Dataverse Web API endpoint for a specific organization
  variables:
    organization:
      default: org
      description: Your Dataverse organization subdomain
security:
- OAuth2: []
tags:
- name: System
  description: System operations and functions exposed by the Web API.
paths:
  /WhoAmI:
    get:
      tags:
      - System
      summary: Get the current user information
      description: Returns the BusinessUnitId, UserId, and OrganizationId of the calling user.
      operationId: whoAmI
      responses:
        '200':
          description: WhoAmIResponse
          content:
            application/json:
              schema:
                type: object
                properties:
                  BusinessUnitId:
                    type: string
                    format: uuid
                  UserId:
                    type: string
                    format: uuid
                  OrganizationId:
                    type: string
                    format: uuid
  /$batch:
    post:
      tags:
      - System
      summary: Execute batch operations
      description: Submit multiple operations or change sets in a single multipart batch request.
      operationId: batch
      requestBody:
        required: true
        content:
          multipart/mixed:
            schema:
              type: string
      responses:
        '200':
          description: Batch response
          content:
            multipart/mixed:
              schema:
                type: string
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: 'Authentication uses Microsoft Entra ID (Azure AD) OAuth 2.0. Acquire a

        bearer token with the audience set to the Dataverse organization URL,

        for example https://{organization}.crm.dynamics.com/.default.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://{organization}.crm.dynamics.com/user_impersonation: Access Dataverse as the signed-in user
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://{organization}.crm.dynamics.com/.default: Application access to Dataverse