---
schema: rendered-html/v1
title: "YouTrack Form API | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/youtrack-form-api.html
generated_at: 2026-06-10T05:36:16.688302+00:00
---






- Sample Script
- [Form API Reference](jetbrains__com__help__youtrack__devportal__form-api-reference.md)

# YouTrack Form API﻿

Last modified: 07 May 2026
> ### note
>
> Required YouTrack Version
>
> YouTrack Form API is compatible with YouTrack starting from version 2023.2.

YouTrack Form API helps you customize helpdesk online forms that you embed in your website. To learn more about YouTrack helpdesk solution, see Helpdesk. For more information about online forms, see Online Forms.

When configuring online forms for a helpdesk project in YouTrack, you can make submitting requests easier for reporters by prefilling specific data in online forms. YouTrack can fill in the values of certain fields (blocks) in the form based on the context in which the form has been embedded.

When you can retrieve some essential data from the context and prefill this data in the online form, you can save the reporter the time to submit the form while still providing the required data in the request. Before submitting the request, the reporter can review and change the prefilled values or leave them filled with suggested values.

You can implement context-sensitive value suggestions in your online form by adding an extra JavaScript block with the form embed code. YouTrack Form API provides you with methods to add these suggestions to your form.

WorkItemSample Script


