Microsoft Purview OKRs API

Operations for managing Objectives and Key Results

Documentation GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /okrs List OKRs in the unified catalog · Microsoft Purview List OKRs #

Ask an LLM

“What objectives and key results are tracked in our unified catalog?”

“Can I page through OKRs a few at a time?”

Tell an agent

List all OKRs.

Show OKRs {size} per page.

POST /okrs Create an objective or key result · Microsoft Purview Create an OKR #

Ask an LLM

“How do I add a new objective to a business domain?”

“Can I create a key result under an existing objective?”

Tell an agent

Create an objective named {name} in business domain {domain}.

Add key result {name} under parent OKR {parent}.

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/microsoft-purview:microsoft-purview-okrs-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Purview Unified Catalog OKRs API
  description: APIs for programmatically integrating and managing the Microsoft Purview Unified Catalog. Supports operations on business domains, glossary terms, data products, OKRs, critical data elements, and data access policies.
  version: 2024-03-01-preview
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/purview/
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://{accountName}.purview.azure.com
  description: Microsoft Purview Unified Catalog API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: OKRs
  description: Operations for managing Objectives and Key Results
paths:
  /okrs:
    get:
      operationId: listOKRs
      summary: Microsoft Purview List OKRs
      description: List all Objectives and Key Results in the Purview unified catalog.
      tags:
      - OKRs
      parameters:
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      - name: maxpagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OKRs listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OKRList'
        '401':
          description: Unauthorized
    post:
      operationId: createOKR
      summary: Microsoft Purview Create an OKR
      description: Create a new Objective and Key Result.
      tags:
      - OKRs
      parameters:
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OKR'
      responses:
        '201':
          description: OKR created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OKR'
        '401':
          description: Unauthorized
components:
  schemas:
    OKR:
      type: object
      description: An Objective and Key Result
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        businessDomainId:
          type: string
        type:
          type: string
          enum:
          - Objective
          - KeyResult
        parentOkrId:
          type: string
        status:
          type: string
          enum:
          - Draft
          - Published
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    OKRList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/OKR'
        nextLink:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: Azure Active Directory OAuth2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://purview.azure.net/.default: Access Microsoft Purview