Azure DevOps

Learn the basic patterns for using the REST APIs for Azure DevOps Services and Azure DevOps Server.

6 APIs 6 Features

AzureCI/CDDevOpsPipelinesWork Items

APIs

Azure DevOps Work Item Tracking API

The Azure DevOps Work Item Tracking API provides REST endpoints for creating, updating, querying, and managing work items including bugs, tasks, user stories, epics, and feature...

Azure DevOps Git Repositories API

The Azure DevOps Git Repositories API provides REST endpoints for managing Git repositories, branches, commits, pull requests, and code reviews. APIs enable automation of reposi...

Azure DevOps Pipelines API

The Azure DevOps Pipelines API provides REST endpoints for managing CI/CD build and release pipelines. APIs support pipeline creation, triggering builds, retrieving build result...

Azure DevOps Artifacts API

The Azure DevOps Artifacts API provides REST endpoints for managing package feeds including NuGet, npm, Maven, Python, and Universal Packages. APIs support feed creation, packag...

Azure DevOps Test Plans API

The Azure DevOps Test Plans API provides REST endpoints for managing test plans, test suites, test cases, and test runs. APIs support automated test management, test result repo...

Azure DevOps Release API

The Azure DevOps Release API provides REST endpoints for managing release pipelines, deployments, and environments. APIs support release definition management, deployment approv...

Collections

Azure DevOps Pipelines API

OPEN

Azure DevOps Work Item Tracking API

OPEN

Pricing Plans

Azure Devops Plans Pricing

6 plans

PLANS

Rate Limits

Azure Devops Rate Limits

4 limits

RATE LIMITS

FinOps

Azure Devops Finops

FINOPS

Features

Work Item Tracking

Create, update, query, and manage work items across Azure Boards

CI/CD Pipelines

Build, test, and deploy with YAML-based and classic pipelines

Git Repositories

Host and manage Git repositories with branch policies and pull requests

Artifacts

Package management for NuGet, npm, Maven, Python, and Universal Packages

Test Plans

Comprehensive test management with automated and manual testing

Release Management

Multi-stage deployment pipelines with approval workflows

Use Cases

Agile Project Management

Track work items, sprints, and backlogs for Agile development teams

CI/CD Automation

Automate build, test, and deployment workflows across environments

Code Review

Enforce branch policies and manage pull request workflows

Integrations

GitHub

Import repositories and trigger pipelines from GitHub events

Slack

Notifications for pipeline runs and work item updates

Jira

Bidirectional sync of work items with Jira issues

Event Specifications

Azure DevOps Service Hooks (Webhooks)

Azure DevOps Service Hooks deliver event notifications for work item changes, build completions, pull request events, code pushes, and release deployments. Service hooks are con...

ASYNCAPI

Semantic Vocabularies

Azure Devops Context

0 classes · 4 properties

JSON-LD

Azure Devops Pipelines Context

0 classes · 0 properties

JSON-LD

Azure Devops Work Items Context

0 classes · 0 properties

JSON-LD

API Governance Rules

Azure DevOps API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Azure Devops Pipelines Create Pipeline Request Structure

3 properties

JSON STRUCTURE

Azure Devops Pipelines Error Structure

2 properties

JSON STRUCTURE

Azure Devops Pipelines Pipeline Run Structure

10 properties

JSON STRUCTURE

Azure Devops Pipelines Pipeline Structure

7 properties

JSON STRUCTURE

Azure Devops Pipelines Run Pipeline Request Structure

4 properties

JSON STRUCTURE

Azure Devops Work Items Error Structure

7 properties

JSON STRUCTURE

Azure Devops Work Items Json Patch Operation Structure

4 properties

JSON STRUCTURE

Azure Devops Work Items Wiql Result Structure

4 properties

JSON STRUCTURE

Azure Devops Work Items Work Item Field Structure

6 properties

JSON STRUCTURE

Azure Devops Work Items Work Item Relation Structure

3 properties

JSON STRUCTURE

Azure Devops Work Items Work Item Structure

5 properties

JSON STRUCTURE

Example Payloads

Azure Devops Pipelines Create Pipeline Request Example

3 fields

EXAMPLE

Azure Devops Pipelines Error Example

2 fields

EXAMPLE

Azure Devops Pipelines Pipeline Example

7 fields

EXAMPLE

Azure Devops Pipelines Pipeline Run Example

10 fields

EXAMPLE

Azure Devops Pipelines Run Pipeline Request Example

4 fields

EXAMPLE

Azure Devops Work Items Error Example

7 fields

EXAMPLE

Azure Devops Work Items Json Patch Operation Example

4 fields

EXAMPLE

Azure Devops Work Items Wiql Result Example

4 fields

EXAMPLE

Azure Devops Work Items Work Item Example

5 fields

EXAMPLE

Azure Devops Work Items Work Item Field Example

6 fields

EXAMPLE

Azure Devops Work Items Work Item Relation Example

3 fields

EXAMPLE

Resources

Documentation

APIReference

GettingStarted

Authentication

Documentation

GitHubOrganization

GitHubOrganization

Node.js SDK

Azure DevOps CLI Extension

Create Pipeline Request Schema

Pipelines Error Schema

Pipeline Run Schema

Pipeline Schema

Run Pipeline Request Schema

Work Items Error Schema

JSON Patch Operation Schema

WIQL Result Schema

Work Item Field Schema

Work Item Relation Schema

Work Item Schema

Work Item Schema (Legacy)

Azure DevOps JSON-LD Context

Pipelines JSON-LD Context

Work Items JSON-LD Context

Azure DevOps Vocabulary

Spectral Rules

DevOps Project Management Workflow

Work Items Shared Capability

Pipelines Shared Capability

Sources

opencollection: 1.0.0
info:
  name: Azure DevOps Work Item Tracking API
  version: '7.2'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: WorkItems
    type: folder
  items:
  - info:
      name: Get Work Item by Id
      type: http
    http:
      method: GET
      url: https://dev.azure.com/{organization}/:project/_apis/wit/workitems/:id
      params:
      - name: organization
        value: example_value
        type: path
      - name: project
        value: example_value
        type: path
        description: Project name or ID
      - name: id
        value: abc123
        type: path
        description: Work item ID
      - name: $expand
        value: all
        type: query
        description: Expand related entities (all, fields, relations, links, none)
      - name: $select
        value: example_value
        type: query
        description: Comma-separated list of fields to return
      - name: api-version
        value: example_value
        type: query
    docs: Returns a single work item by its numeric ID. Supports field selection and expansion of related entities.
  - info:
      name: Update Work Item
      type: http
    http:
      method: PATCH
      url: https://dev.azure.com/{organization}/:project/_apis/wit/workitems/:id
      params:
      - name: organization
        value: example_value
        type: path
      - name: project
        value: example_value
        type: path
      - name: id
        value: abc123
        type: path
      - name: api-version
        value: example_value
        type: query
      - name: suppressNotifications
        value: 'true'
        type: query
      body:
        type: json
        data: '{}'
    docs: Updates a work item using JSON Patch operations. Supports updating fields, adding/removing links, and attaching
      files.
  - info:
      name: Create a New Work Item
      type: http
    http:
      method: POST
      url: https://dev.azure.com/{organization}/:project/_apis/wit/workitems/$:type
      params:
      - name: organization
        value: example_value
        type: path
      - name: project
        value: example_value
        type: path
      - name: type
        value: example_value
        type: path
        description: Work item type (e.g., Bug, Task, User Story, Epic, Feature)
      - name: api-version
        value: example_value
        type: query
      body:
        type: json
        data: '{}'
    docs: Creates a new work item of the specified type. Uses JSON Patch to set field values.
  - info:
      name: Get Work Items by Ids
      type: http
    http:
      method: GET
      url: https://dev.azure.com/{organization}/:project/_apis/wit/workitems
      params:
      - name: organization
        value: example_value
        type: path
      - name: project
        value: example_value
        type: path
      - name: ids
        value: example_value
        type: query
        description: Comma-separated list of work item IDs (max 200)
      - name: $expand
        value: example_value
        type: query
      - name: api-version
        value: example_value
        type: query
    docs: Returns multiple work items by a list of IDs.
- info:
    name: Queries
    type: folder
  items:
  - info:
      name: Query Work Items Using Wiql
      type: http
    http:
      method: POST
      url: https://dev.azure.com/{organization}/:project/_apis/wit/wiql
      params:
      - name: organization
        value: example_value
        type: path
      - name: project
        value: example_value
        type: path
      - name: $top
        value: '10'
        type: query
        description: Maximum number of results to return
      - name: api-version
        value: example_value
        type: query
      body:
        type: json
        data: '{}'
    docs: Executes a Work Item Query Language (WIQL) query to find work items matching the specified criteria.
- info:
    name: Fields
    type: folder
  items:
  - info:
      name: List Work Item Fields
      type: http
    http:
      method: GET
      url: https://dev.azure.com/{organization}/:project/_apis/wit/fields
      params:
      - name: organization
        value: example_value
        type: path
      - name: project
        value: example_value
        type: path
      - name: api-version
        value: example_value
        type: query
    docs: Returns all work item fields defined in the project or organization.
bundled: true