YouTrack REST API
Number of APIs: 243
Welcome to the YouTrack workspace!
Here you will find a collection of requests that you can make with the YouTrack REST API.
This collection is maintained by the YouTrack team. If you have any questions related to the collection or to the YouTrack REST API, please send us a message to youtrack-support@jetbrains.com.
To use this collection, fork it to your workspace and change the collection variables to the values relevant to your environment.
For the full YouTrack REST API documentation, see YouTrack REST API Reference.
Main Collection Variables
Set these two main variables and you can start using the YouTrack REST API collection.
| Variable | Description |
|---|---|
| baseUrl | The Base REST API URL of the YouTrack service. For more info, see REST API URL and Endpoints. |
| token | The permanent token for the user account that you use to log in to YouTrack. For more info on how to create a permanent token, see Create a Permanent Token. |
Additional Variables
You will need some of these variables for specific requests. Check the documentation for each request to find out if you need any additional variables for it.
| Variable | Description |
|---|---|
| activityItemID | The database ID of a sample activity item. To get the ID of an activity item in an issue, send a GET request to /api/issues/{{sampleIssue}}/activities?fields=id,author(name,login),timestamp,target(id,text)&categories={{Category}} and find the ID of the target activity item. To learn about available activity categories, see ActivityCategory. |
| agileBoardID | The database ID of a sample agile board. To get the ID of an agile board, send a GET request to /api/agiles?fields=id,name and find the ID of the target agile board. |
| articleID | The ID of a sample article. In most requests, you can use the article ID as seen in the interface. To get the database ID of an article, send a GET request to /api/articles?fields=id,summary and find the ID of the target article. |
| articleAttachmentID | The database ID of a sample article attachment. To get the ID of an article attachment, send a GET request to /api/articles/{{articleID}}/attachments?fields=id,name and find the ID of the target article attachment. |
| articleCommentID | The database ID of a sample comment to an article. To get the ID of a comment to an article, send a GET request to /api/articles/{{articleID}}/comments?fields=id,author(id,name),text,created and find the ID of the target comment. |
| backupFileName | The name of a sample backup file. To get the name of a backup file, send a GET request to /api/admin/databaseBackup/backups?fields=id,name and find the name of the target backup file. |
| buildBundleID | The database ID of a sample set of build custom field values. To get the ID of a BuildBundle, send a GET request to /api/admin/customFieldSettings/bundles/build?fields=id,name and find the ID of the target build bundle. |
| buildBundleElementID | The database ID of a sample value from a set of build custom field values. To get the ID of a BuildBundleElement, send a GET request to /api/admin/customFieldSettings/bundles/build/{{buildBundleID}}/values?fields=id,name and find the ID of the target build element. |
| customFieldID | The database ID of a sample common custom field. To get the ID of a CustomField, send a GET request to /api/admin/customFieldSettings/customFields?fields=id,name and find the ID of the target custom field. |
| enumBundleID | The database ID of a sample set of enum custom field values. To get the ID of an EnumBundle, send a GET request to /api/admin/customFieldSettings/bundles/enum?fields=id,name and find the ID of the target enum bundle. |
| enumBundleElementID | The database ID of a sample value from a set of enum custom field values. To get the ID of an EnumBundleElement, send a GET request to /api/admin/customFieldSettings/bundles/enum/{{enumBundleID}}/values?fields=id,name and find the ID of the target enum element. |
| groupID | The database ID of a sample user group. To get the ID of a user group, send a GET request to /api/groups?fields=id,login and find the ID of the target user group. |
| issue | The human-readable ID of a sample issue. In most requests, you can use the issue ID as seen in the interface. |
| issueID | The database ID of a sample issue. To get the ID of an issue, send a GET request to /api/issues?fields=id,summary and find the ID of the target issue. |
| issueAttachmentID | The database ID of a sample issue attachment. To get the ID of an issue attachment, send a GET request to /api/issues/{{sampleIssue}}/attachments?fields=id,name and find the ID of the target issue attachment. |
| issueCommentID | The database ID of a sample comment to an issue. To get the ID of an issue comment to an issue, send a GET request to /api/issues/{{sampleIssue}}/comments?fields=id,text and find the ID of the target comment. |
| issueCustomFieldID | The database ID of a sample issue custom field. To get the ID of an IssueCustomField, send a GET request to /api/issues/{{sampleIssue}}/fields?fields=id,name and find the ID of the target issue custom field. |
| issueLinkID | The database ID of a sample link between two issues. To get the name of an issue link, send a GET request to /api/issues/{{sampleIssue}}/links?fields=id,idReadable,direction,linkType(name,localizedName,sourceToTarget,targetToSource,directed,aggregation),issues(id,idReadable,summary) and find the ID of the target issue link. |
| issueLinkTypeID | The database ID of a sample issue link type. To get the ID of an issue link type, send a GET request to /api/issueLinkTypes?fields=id,name,aggregation,directed,sourceToTarget,targetToSource and find the ID of the target link type. |
| issueTagID | The database ID of a sample issue tag. To get the ID of a tag, send a GET request to /api/issueTags?fields=id,name and find the ID of the target tag. |
| ownedBundleID | The database ID of a sample set of owned custom field values. To get the ID of an OwnedBundle, send a GET request to /api/admin/customFieldSettings/bundles/ownedField?fields=id,name and find the ID of the target owned bundle. |
| ownedBundleElementID | The database ID of a sample value from a set of owned custom field values. To get the ID of an OwnedBundleElement, send a GET request to /api/admin/customFieldSettings/bundles/ownedField/{{ownedBundleID}}/values?fields=id,name and find the ID of the target owned element. |
| periodProjectCustomFieldID | The database ID of a sample project custom field of period type. To get the ID of a PeriodProjectCustomField, send a GET request to /api/admin/projects/{{sampleProjectID}}/customFields?fields=id,field(name,fieldType) and find the ID of the target period custom field. |
| projectID | The database ID of a sample project. To get the ID of a project, send a GET request to /api/admin/projects?fields=id,name,shortName and find the ID of the target project. |
| projectCustomFieldID | The database ID of a sample project custom field. To get the ID of a ProjectCustomField, send a GET request to /api/admin/projects/{{sampleProjectID}}/customFields?fields=id,field(name,fieldType) and find the ID of the target project custom field. |
| savedQueryID | The database ID of a sample saved search. To get the ID of a saved search, send a GET request to /api/savedQueries?fields=id,name,query and find the ID of the target saved search. |
| sprintID | The database ID of a sample sprint on an agile board. To get the ID of a sprint, send a GET request to /api/agiles/{{agileBoardID}}/sprints?fields=id,name,start,finish and find the ID of the target sprint. |
| stateBundleID | The database ID of a sample set of state custom field values. To get the ID of a StateBundle, send a GET request to /api/admin/customFieldSettings/bundles/state?fields=id,name and find the ID of the target state bundle. |
| stateBundleElementID | The database ID of a sample value from a set of state custom field values. To get the ID of an StateBundleElement, send a GET request to /api/admin/customFieldSettings/bundles/state/{{stateBundleID}}/values?fields=id,name and find the ID of the target state element. |
| subArticleID | The database ID of a sample sub-article. To get the ID of a sub-article, send a GET request to /api/articles/{{articleID}}/childArticles?fields=id,summary,idReadable and find the ID of the target sub-article. |
| userID | The database ID of a sample user. To get the ID of a user, send a GET request to /api/users?fields=id,login and find the ID of the target user. |
| userBundleID | The database ID of a sample set of users. To get the ID of a UserBundle, send a GET request to /api/admin/customFieldSettings/bundles/user?fields=id,name and find the ID of the target user bundle. |
| versionBundleID | The database ID of a sample set of version custom field values. To get the ID of a VersionBundle, send a GET request to /api/admin/customFieldSettings/bundles/version?fields=id,name and find the ID of the target version bundle. |
| versionBundleElementID | The database ID of a sample value from a set of version custom field values. To get the ID of an VersionBundleElement, send a GET request to /api/admin/customFieldSettings/bundles/versrion/{{versionBundleID}}/values?fields=id,name and find the ID of the target version element. |
| workItemID | The database ID of a sample work item. To get the ID of a work item, send a GET request to /api/issues/{{sampleIssue}}/timeTracking/workItems?fields=id,author(id,name),date,duration(id,minutes,presentation) and find the ID of the target work item. |
| workItemTypeID | The database ID of a sample work item type. To get the ID of a work item type, send a GET request to /api/admin/timeTrackingSettings/workItemTypes?fields=id,name and find the ID of the target work item type. |
-
Administration-Projects-Operations with Specific Project-Project Custom Fields-Operations with Specific ProjectCustomField - Delete a Specific ProjectCustomField DELETE {{baseUrl}}/admin/projects/:id/customFields/:projectCustomFieldId
-
Administration-Custom Field Settings-Bundles-Enum Bundles-Operations with Specific EnumBundle - Update a Specific EnumBundle POST {{baseUrl}}/admin/customFieldSettings/bundles/enum/:id?fields=name,id,values(name,id,description,ordinal),isUpdateable
-
Administration-Custom Field Settings-Bundles-Enum Bundles-Operations with Specific EnumBundle - Read a Specific EnumBundle GET {{baseUrl}}/admin/customFieldSettings/bundles/enum/:id?fields=name,id,values(name,id,description,ordinal),isUpdateable
-
Administration-Custom Field Settings-Bundles-Enum Bundles-Operations with Specific EnumBundle - Delete a Specific EnumBundle DELETE {{baseUrl}}/admin/customFieldSettings/bundles/enum/:id
-
Administration-Custom Field Settings-Bundles-Enum Bundles - Read a List of EnumBundles GET {{baseUrl}}/admin/customFieldSettings/bundles/enum?fields=name,id,values(name,id,description,ordinal),isUpdateable
-
Administration-Custom Field Settings-Bundles-User Bundles - Add a New UserBundle POST {{baseUrl}}/admin/customFieldSettings/bundles/user?fields=id,name,aggregatedUsers(id,login)
-
Administration-Custom Field Settings-Bundles-Build Bundles - Read a List of BuildBundles GET {{baseUrl}}/admin/customFieldSettings/bundles/build?fields=id,name,fieldType(presentation,id)
-
Administration-Custom Field Settings-Bundles-Build Bundles-Operations with Specific Build Bundle - Delete a Specific BuildBundle DELETE {{baseUrl}}/admin/customFieldSettings/bundles/build/:id
-
Administration-Custom Field Settings-Bundles-Build Bundles-Operations with Specific Build Bundle-Values in the Build Bundle-Operations with Specific BuildBundleElement - Update a Specific BuildBundleElement POST {{baseUrl}}/admin/customFieldSettings/bundles/build/:id/values/:buildBundleElementId?fields=id,name,assembleDate,description
-
Administration-Custom Field Settings-Bundles-Build Bundles-Operations with Specific Build Bundle-Values in the Build Bundle-Operations with Specific BuildBundleElement - Read a Specific BuildBundleElement GET {{baseUrl}}/admin/customFieldSettings/bundles/build/:id/values/:buildBundleElementId?fields=id,name,assembleDate,description