---
schema: rendered-html/v1
title: "REST API URL and Endpoints | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/api-url-and-endpoints.html
generated_at: 2026-06-11T15:00:50.557924+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
- Get Started with REST API
- Log in to YouTrack
- [REST API URL and Endpoints](api-url-and-endpoints.html)
- OpenAPI Specification (OAS)
- Fields Syntax
- [Query Syntax](jetbrains__com__help__youtrack__devportal__api-query-syntax.md)
- Request Headers
- 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
- REST API Reference
- [REST API Use Cases](jetbrains__com__help__youtrack__devportal__api-use-cases.md)
- [REST API Troubleshooting](jetbrains__com__help__youtrack__devportal__api-troubleshooting.md)
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. Get Started with REST API
3. [REST API URL and Endpoints](#0)

# REST API URL and Endpoints﻿

Last modified: 07 May 2026

YouTrack's REST API is available by the following URL:

{YouTrack-Service-URL}/api

## YouTrack Server REST API URL﻿

`<YouTrack Service URL>` is the base URL of the YouTrack service in your network environment. For example, you have your company's server `www.example.com` and a YouTrack service. You can configure YouTrack to be accessible by `www.example.com/youtrack` or, let's say `youtrack.example.com`.

`/api` is the context path for the REST API of your YouTrack service. Append this path to the YouTrack service URL to get the URL for the REST API.

For the sample service URLs above, REST API URLs are as follows:

| YouTrack Service URL | YouTrack REST API URL |
| --- | --- |
| `https://www.example.com/youtrack` | `https://www.example.com/youtrack/api` |
| `https://youtrack.example.com` | `https://youtrack.example.com/api` |

Here are the examples of the endpoint URLs to get the profile of the current user:

- For `www.example.com/youtrack`:

  https://www.example.com/youtrack/api/users/me
- For `youtrack.example.com`:

  https://youtrack.example.com/api/users/me

## YouTrack Cloud REST API URL﻿

`<YouTrack Service URL>` is the base URL of your YouTrack Cloud instance.

If your YouTrack Cloud instance is hosted on `myjetbrains.com`, its service URL must have the `/youtrack` context appended. For example, `https://example.myjetbrains.com/youtrack`.

`/api` is the context path for the REST API of your YouTrack service. Append this path to the YouTrack service URL to get the URL for the REST API.

For the instances hosted on default YouTrack Cloud domains, REST API URLs are as follows:

| YouTrack Service URL | YouTrack REST API URL |
| --- | --- |
| `https://example.youtrack.cloud` | `https://example.youtrack.cloud/api` |
| `https://example.myjetbrains.com/youtrack` | `https://example.myjetbrains.com/youtrack/api` |

Here are the examples of the endpoint URLs to get the profile of the current user:

- For `example.youtrack.cloud`:

  https://example.youtrack.cloud/api/users/me
- For `example.myjetbrains.com`:

  https://example.myjetbrains.com/youtrack/api/users/me

## Custom Endpoints﻿

Custom REST endpoints are user-defined endpoints that let you extend the YouTrack REST API. Custom endpoints can be added to YouTrack by installing an app that contains one or more HTTP Handlers. These custom endpoints let you introduce additional capabilities into the YouTrack REST API to meet your specific needs.

When you call a custom REST endpoint, you invoke its corresponding HTTP handler. The endpoints used are based on the scope property assigned to the handler.

| Scope | URL |
| --- | --- |
| `issue` | <host>/api/issues/<issueId>/extensionEndpoints/app/handler/endpoint |
| `article` | <host>/api/articles/<articleId>/extensionEndpoints/app/handler/endpoint |
| `project` | <host>/api/admin/projects/<projectId>/extensionEndpoints/app/handler/endpoint |
| `user` | <host>/api/users/<userId>/extensionEndpoints/app/handler/endpoint |
| `global` | <host>/api/extensionEndpoints/app/handler/endpoint |

Set the following variables to match your app:

- `app` — the name of your app.
- `handler` — the name of the file that contains the HTTP handler script in the app package without the `.js` file extension.
- `endpoint` — the path from the declaration. For example, `"path": "/endpoint"`

Each API request requires the same permissions as the scope entity. For example, the endpoint /api/issues/DEMO-1/extensionEndpoints/app/handler/endpoint is accessible to any user who has permission to access the issue with the ID DEMO-1. Global endpoints are accessible to all users except the guest account.

- [REST API URL and Endpoints](/help/youtrack/devportal/api-url-and-endpoints.html)
- [YouTrack Server REST API URL](/help/youtrack/devportal/api-url-and-endpoints.html#standalone-url)
- [YouTrack Cloud REST API URL](/help/youtrack/devportal/api-url-and-endpoints.html#incloud-url)
- [Custom Endpoints](/help/youtrack/devportal/api-url-and-endpoints.html#custom-REST-endpoints)

OAuth 2.0 AuthorizationOpenAPI Specification (OAS)

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

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

![](https://bat.bing.com/action/0?ti=5220035&tm=gtm002&Ver=2&mid=d89ef94e-8caf-4bd5-a91a-83199e305120&bo=4&sid=452929b065a111f19a7fe7356f74a419&vid=aa3122f0648711f1a10d6d095e10fd87&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1920&sh=1080&sc=24&tl=REST%20API%20URL%20and%20Endpoints%20%7C%20Developer%20Portal%20for%20YouTrack%20and%20Hub%20Documentation&p=https%3A%2F%2Fwww.jetbrains.com%2Fhelp%2Fyoutrack%2Fdevportal%2Fapi-url-and-endpoints.html&r=&lt=766&pt=1781190048437,29,29,,,2,2,2,2,2,,3,25,25,33,223,223,224,765,766,766&pn=0,0&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=613399)
