Microsoft Dynamics Opportunities API

openapi: 3.2.0
info:
  title: Microsoft Dynamics 365 Dataverse Web Opportunities API
  description: The Microsoft Dynamics 365 Dataverse Web API provides a RESTful endpoint for interacting with Dataverse data used by Dynamics 365 Sales, Customer Service, Field Service, and other customer engagement applications. It implements OData v4 and supports CRUD operations on core CRM entities including accounts, contacts, leads, and opportunities. Authentication is handled via Microsoft Entra ID (Azure AD).
  version: '9.2'
  contact:
    name: Microsoft
    url: https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/overview
  license:
    name: Microsoft APIs Terms of Use
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
servers:
- url: https://{organization}.api.crm.dynamics.com/api/data/v9.2
  description: Dynamics 365 Online (North America)
  variables:
    organization:
      default: org
      description: The unique name of your Dataverse organization.
- url: https://{baseUrl}/api/data/v9.2
  description: Dynamics 365 On-Premises
  variables:
    baseUrl:
      default: localhost
security:
- oauth2: []
tags:
- name: Opportunities
paths:
  /opportunities:
    get:
      summary: Microsoft Dynamics List opportunities
      description: Retrieves a collection of opportunity records.
      operationId: listOpportunities
      tags:
      - Opportunities
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/orderby'
      - $ref: '#/components/parameters/expand'
      responses:
        '200':
          description: A collection of opportunities.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Opportunity'
    post:
      summary: Microsoft Dynamics Create an opportunity
      description: Creates a new opportunity record.
      operationId: createOpportunity
      tags:
      - Opportunities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Opportunity'
      responses:
        '204':
          description: Opportunity created successfully.
          headers:
            OData-EntityId:
              description: URI of the created record.
              schema:
                type: string
  /opportunities({opportunityid}):
    get:
      summary: Microsoft Dynamics Get an opportunity
      description: Retrieves a single opportunity by ID.
      operationId: getOpportunity
      tags:
      - Opportunities
      parameters:
      - name: opportunityid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/expand'
      responses:
        '200':
          description: An opportunity record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Opportunity'
    patch:
      summary: Microsoft Dynamics Update an opportunity
      description: Updates an existing opportunity record.
      operationId: updateOpportunity
      tags:
      - Opportunities
      parameters:
      - name: opportunityid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/ifMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Opportunity'
      responses:
        '204':
          description: Opportunity updated successfully.
    delete:
      summary: Microsoft Dynamics Delete an opportunity
      description: Deletes an opportunity record.
      operationId: deleteOpportunity
      tags:
      - Opportunities
      parameters:
      - name: opportunityid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Opportunity deleted successfully.
components:
  parameters:
    filter:
      name: $filter
      in: query
      description: OData filter expression.
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Maximum number of records to return.
      schema:
        type: integer
    orderby:
      name: $orderby
      in: query
      description: Comma-separated list of properties to sort by.
      schema:
        type: string
    expand:
      name: $expand
      in: query
      description: Related entities to expand inline.
      schema:
        type: string
    skip:
      name: $skip
      in: query
      description: Number of records to skip.
      schema:
        type: integer
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to include.
      schema:
        type: string
    ifMatch:
      name: If-Match
      in: header
      description: ETag value for optimistic concurrency.
      schema:
        type: string
  schemas:
    Opportunity:
      type: object
      properties:
        opportunityid:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
        description:
          type: string
        estimatedvalue:
          type: number
          format: decimal
        estimatedclosedate:
          type: string
          format: date
        actualvalue:
          type: number
          format: decimal
        actualclosedate:
          type: string
          format: date
        closeprobability:
          type: integer
        currentsituation:
          type: string
        customerneed:
          type: string
        proposedsolution:
          type: string
        stepname:
          type: string
        statecode:
          type: integer
          description: 0 = Open, 1 = Won, 2 = Lost
        statuscode:
          type: integer
        createdon:
          type: string
          format: date-time
          readOnly: true
        modifiedon:
          type: string
          format: date-time
          readOnly: true
  securitySchemes:
    oauth2:
      type: oauth2
      description: Microsoft Entra ID (Azure AD) OAuth 2.0 authentication.
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://org.crm.dynamics.com/.default: Access Dataverse API