---
schema: rendered-html/v1
title: "YouTrack Workflow API | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/YouTrack-Api-Documentation.html
generated_at: 2026-06-11T14:44:08.666064+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
- JavaScript Workflow Quick Start Guide
- Create a Workflow
- Edit a Workflow
- Workflow Rule Types
- Transactions
- Use Cases for Workflows
- Web-based Workflow Editor
- Using an External Code Editor
- Default Workflows
- Custom Workflow Repository
- JavaScript Workflow Reference
- Rule-specific Properties
- Context
- Requirements
- Using the Workflow API
- [Building Integrations with Slack](jetbrains__com__help__youtrack__devportal__slack-integration-html.md)
- Using REST API Methods in JavaScript Workflows
- Working with Dates and Times
- Working with Periods
- Localized Workflow Messages
- Troubleshooting Workflows
- Remote Debugger
- [YouTrack Workflow API](YouTrack-Api-Documentation.html)
- Change Log
- date-time
- entities
- http
- license
- notifications
- search
- strings
- workflow
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Hub REST API

1. YouTrack Workflows
2. JavaScript Workflow Reference
3. [YouTrack Workflow API](#0)

# YouTrack Workflow API﻿

Last modified: 07 May 2026

The `@jetbrains/youtrack-scripting-api` package includes a collection of modules. These modules provide the custom functions, methods, and constructors that let you reference and update entities in YouTrack. They also define the properties that are available for each entity.

The following modules are available:

| Module | Description |
| --- | --- |
| date-time | This module contains functions that let you work with dates and times. |
| entities | Contains definitions for the entities in YouTrack that are accessible to workflows. |
| http | Contains definitions for objects and classes that exchange and transfer data over HTTP. The main class is Connection. |
| license |  |
| notifications | This module contains functionality for sending email messages. These messages are independent from the notification scheme that is used for subscriptions to issue updates in YouTrack. All of the components for these email messages are defined in the parameters for the function that is supported in this module. However, the messages are still sent by the SMTP server that is connected to your YouTrack installation. |
| search | This module contains functionality that lets you search for issues in YouTrack. |
| strings | This module provides support for a specific string utility from the standard Java library. All of the other methods that you can use to work with strings in workflows are taken from the standard JavaScript library and behave as described in the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String). |
| workflow | This module contains utility functions that display workflow-related messages and warnings in the user interface. |

Remote DebuggerChange Log

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

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