Azure DevOps API

Development / API Key Intermediate HTTPS
Varies by plan (check documentation)

Overview

Azure DevOps REST API provides programmatic access to all Azure DevOps services including work items, repositories, pipelines, test plans, and artifact feeds. It supports both Azure DevOps Services (cloud) and Azure DevOps Server (on-premises) and is the backbone for CI/CD automation and developer tooling integrations. Authentication is via Personal Access Tokens (PATs) which are treated as the "API key" in requests.

💡

Beginner Tip

Generate a Personal Access Token (PAT) in Azure DevOps under User Settings > Personal Access Tokens and grant only the scopes you need. Pass it in every request as a Basic Auth header where the password is the PAT: -H "Authorization: Basic $(echo -n :YOUR_PAT | base64)".

Available Data

Azure DevOps data via REST API
JSON-formatted response data
Requires API key authentication

Example Response

JSON Response
{
  "status": "success",
  "data": {
    "result": "Data from Azure DevOps",
    "description": "The Azure DevOps basic components of a REST API request/response pair",
    "timestamp": "2025-01-15T10:00:00Z"
  }
}

Field Reference

value Array of resource objects returned by the list endpoint.
count Total number of items in the current response page.
id Unique numeric identifier for the work item or resource.
fields Dictionary of work item field values keyed by field reference name, e.g., System.Title.
url Self-referencing REST URL for this specific resource.

Implementation Example

const url = "https://docs.microsoft.com/en-us/rest/api/azure/devops";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "X-API-Key": "YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

203 Non-Authoritative or 401 Unauthorized The PAT is expired, has insufficient scopes, or was not base64-encoded correctly.
Regenerate the PAT with the required scope (e.g., Work Items: Read & Write) and ensure it is base64-encoded as :PAT (with leading colon) before sending.
404 on project or repository endpoints The organization name or project name in the URL is wrong or the resource was deleted.
Verify the exact organization and project names from the Azure DevOps portal URL (https://dev.azure.com/{organization}/{project}).
Pagination truncation — only 200 items returned List endpoints cap at 200 items per page by default.
Use the $top and $skip query parameters, or use the continuationToken returned in the response header to iterate through all pages.

Matrix Score Breakdown

🌐 Reachability 30/30
⚡ Speed 15/20
🔒 Security 15/15
🛠 Developer XP 12/20
✓ Reliability 10/15

Partially tested on Apr 5, 2026

Technical Specifications

Auth API Key
HTTPS REQUIRED
CORS UNKNOWN
Category Development
Difficulty Intermediate
Verified: 2026-04-07

Similar APIs

View All →