---
schema: rendered-html/v1
title: "OpenAPI Specification (OAS) | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/youtrack-openapi-specification.html
generated_at: 2026-06-11T15:21:11.806796+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- [YouTrack REST API](jetbrains__com__help__youtrack__devportal__youtrack-rest-api.md)
- Get Started with REST API
- Log in to YouTrack
- REST API URL and Endpoints
- [OpenAPI Specification (OAS)](youtrack-openapi-specification.html)
- Fields Syntax
- Query Syntax
- [Request Headers](jetbrains__com__help__youtrack__devportal__yt-api-headers.md)
- Custom Fields in REST API
- Pagination
- Users, Groups, and Access Management
- Hub REST API Endpoints Deprecated in YouTrack 2026.1
- [Postman Collection for the YouTrack REST API](jetbrains__com__help__youtrack__devportal__youtrack-postman-collection.md)
- REST API Reference
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. [YouTrack REST API](jetbrains__com__help__youtrack__devportal__youtrack-rest-api.md)
2. Get Started with REST API
3. [OpenAPI Specification (OAS)](#0)

# OpenAPI Specification (OAS)﻿

Last modified: 07 May 2026

We're using Swagger to generate and publish an OpenAPI Specification (OAS) document for the YouTrack REST API. This richly annotated OAS 3.0 definition is produced in JSON format. This artifact is designed to be fed into interactive API consoles and used to build client libraries for developing external applications that integrate with YouTrack.

The OAS 3.0 definition is compatible with tools like [Swagger](https://swagger.io/), [Open API Generator](https://openapi-generator.tech/), and [Postman](https://www.postman.com/). These tools give you the ability to work with the API in different ways:

- Interact with the API in a sandbox UI that helps you understand how the API responds to different parameters and options.
- View and test each resource before using it in your codebase.
- Generate client libraries in your preferred programming language.

## Accessing the OpenAPI Specification﻿

The OAS 3.0 definition is published to the following web address:

```
<YouTrack Service URL>/api/openapi.json
```

The `<YouTrack Service URL>` is the base URL of the YouTrack service in your network environment or the base URL of your YouTrack Cloud. For more details about the base URL and the REST API URL, see REST API URL and Endpoints.

Below you can find examples of OAS definition URLs for different YouTrack setups:

YouTrack Server

YouTrack Cloud

| YouTrack Service URL | OAS Definition URL |
| --- | --- |
| `https://www.example.com/youtrack` | `https://www.example.com/youtrack/api/openapi.json` |
| `https://youtrack.example.com` | `https://youtrack.example.com/api/openapi.json` |

| YouTrack Service URL | OAS Definition URL |
| --- | --- |
| `https://example.youtrack.cloud` | `https://example.youtrack.cloud/api/openapi.json` |
| `https://example.myjetbrains.com/youtrack` | `https://example.myjetbrains.com/youtrack/api/openapi.json` |

>

In any case, all you need to do to access the OpenAPI Specification is add `/api/openapi.json` to the address that is set up as the base URL for your YouTrack.

- [OpenAPI Specification (OAS)](/help/youtrack/devportal/youtrack-openapi-specification.html)
- [Accessing the OpenAPI Specification](/help/youtrack/devportal/youtrack-openapi-specification.html#accessing-open-api-specification)

REST API URL and EndpointsFields Syntax

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
