---
schema: rendered-html/v1
title: "Entities | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/api-entities.html
generated_at: 2026-06-11T14:44:20.920888+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
- REST API Reference
- [Entities](api-entities.html)
- [AccessScope](jetbrains__com__help__youtrack__devportal__api-entity-accessscope.md)
- ActivityCategory
- ActivityCursorPage
- ActivityItem
- Agile
- AgileColumn
- AgileSharingSettings
- AgileStatus
- AppearanceSettings
- ArticleAttachment
- ArticleComment
- AssignedRole
- BackupError
- BackupFile
- BackupStatus
- BaseArticle
- BaseWorkItem
- Bundle
- BundleElement
- ChangesProcessor
- ColorCoding
- ColumnSettings
- CommandList
- CommandVisibility
- CustomField
- CustomFieldCondition
- CustomFieldDefaults
- DatabaseAttributeValue
- DatabaseBackupSettings
- DateFormatDescriptor
- DuplicateVote
- DurationValue
- EmailSettings
- Event
- ExternalArticle
- ExternalIssue
- FieldStyle
- FieldType
- FilterField
- GeneralUserProfile
- GlobalSettings
- GlobalTimeTrackingSettings
- Issue
- IssueAttachment
- IssueComment
- IssueCountResponse
- IssueCustomField
- IssueFolder
- IssueKey
- IssueLink
- IssueLinkType
- IssueTimeTracking
- IssueVoters
- IssueWatcher
- IssueWatchers
- License
- LocaleDescriptor
- LocaleSettings
- Logo
- NotificationSettings
- NotificationsUserProfile
- OnlineUsers
- Organization
- ParsedCommand
- PeriodFieldFormat
- PeriodValue
- Permission
- ProjectColor
- ProjectCustomField
- ProjectTimeTrackingSettings
- PullRequest
- PullRequestChange
- PullRequestState
- Reaction
- RestCorsSettings
- Role
- SearchSuggestions
- Sprint
- SprintsSettings
- StorageEntry
- Suggestion
- SwimlaneSettings
- SwimlaneValue
- SystemSettings
- TagSharingSettings
- Telemetry
- TextFieldValue
- TimeTrackingUserProfile
- TimeZoneDescriptor
- User
- UserGroup
- UserProfiles
- UserType
- VcsChange
- VcsServer
- Visibility
- WIPLimit
- WatchFolderSharingSettings
- WorkItemAttribute
- WorkItemAttributePrototype
- WorkItemAttributeValue
- WorkItemProjectAttribute
- WorkItemType
- WorkTimeSettings
- Resources
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. [Entities](#0)

# Entities﻿

Last modified: 07 May 2026

This section contains the current version of the generated REST API entities reference.

- [AccessScope](jetbrains__com__help__youtrack__devportal__api-entity-accessscope.md)
  - GlobalScope
  - OrganizationScope
  - ProjectScope
- ActivityCategory
- ActivityCursorPage
- ActivityItem
  - CreatedDeletedActivityItem
    - AttachmentActivityItem
    - CommentActivityItem
    - IssueCreatedActivityItem
    - PullRequestChangeActivityItem
    - VcsChangeActivityItem
    - WorkItemActivityItem
  - CustomFieldActivityItem
    - TextCustomFieldActivityItem
  - MultiValueActivityItem
    - CommentAttachmentsActivityItem
    - LinksActivityItem
    - SprintActivityItem
    - TagsActivityItem
    - VisibilityActivityItem
      - VisibilityGroupActivityItem
      - VisibilityUserActivityItem
    - VotersActivityItem
    - WorkItemTypeActivityItem
  - SingleValueActivityItem
    - ProjectActivityItem
    - SimpleValueActivityItem
      - IssueResolvedActivityItem
      - TextMarkupActivityItem
      - UsesMarkupActivityItem
    - WorkItemAuthorActivityItem
    - WorkItemDurationActivityItem
- Agile
- AgileColumn
- AgileSharingSettings
- AgileStatus
- AppearanceSettings
- ArticleAttachment
- ArticleComment
- AssignedRole
- BackupError
- BackupFile
- BackupStatus
- BaseArticle
  - Article
- BaseWorkItem
  - IssueWorkItem
- Bundle
  - BaseBundle
    - BuildBundle
    - EnumBundle
    - OwnedBundle
    - StateBundle
    - VersionBundle
  - UserBundle
- BundleElement
  - BuildBundleElement
  - LocalizableBundleElement
    - EnumBundleElement
    - StateBundleElement
  - OwnedBundleElement
  - VersionBundleElement
- ChangesProcessor
  - JenkinsChangesProcessor
  - TeamcityChangesProcessor
  - VcsHostingChangesProcessor
    - BitBucketChangesProcessor
    - BitbucketStandaloneChangesProcessor
    - GitHubChangesProcessor
    - GitLabChangesProcessor
    - GiteaChangesProcessor
    - GogsChangesProcessor
    - SpaceChangesProcessor
- ColorCoding
  - FieldBasedColorCoding
  - ProjectBasedColorCoding
- ColumnSettings
- CommandList
- CommandVisibility
  - CommandLimitedVisibility
  - CommandUnlimitedVisibility
- CustomField
- CustomFieldCondition
  - FieldBasedCondition
- CustomFieldDefaults
  - BundleCustomFieldDefaults
    - BuildBundleCustomFieldDefaults
    - EnumBundleCustomFieldDefaults
    - OwnedBundleCustomFieldDefaults
    - StateBundleCustomFieldDefaults
    - VersionBundleCustomFieldDefaults
  - UserCustomFieldDefaults
- DatabaseAttributeValue
  - AgileColumnFieldValue
  - SwimlaneEntityAttributeValue
- DatabaseBackupSettings
- DateFormatDescriptor
- DuplicateVote
- DurationValue
- EmailSettings
- Event
- ExternalArticle
- ExternalIssue
- FieldStyle
- FieldType
- FilterField
  - CustomFilterField
  - PredefinedFilterField
- GeneralUserProfile
- GlobalSettings
- GlobalTimeTrackingSettings
- Issue
- IssueAttachment
- IssueComment
- IssueCountResponse
- IssueCustomField
  - MultiValueIssueCustomField
    - MultiBuildIssueCustomField
    - MultiEnumIssueCustomField
    - MultiGroupIssueCustomField
    - MultiOwnedIssueCustomField
    - MultiUserIssueCustomField
    - MultiVersionIssueCustomField
  - PeriodIssueCustomField
  - SimpleIssueCustomField
    - DateIssueCustomField
  - SingleValueIssueCustomField
    - SingleBuildIssueCustomField
    - SingleEnumIssueCustomField
    - SingleGroupIssueCustomField
    - SingleOwnedIssueCustomField
    - SingleUserIssueCustomField
    - SingleVersionIssueCustomField
    - StateIssueCustomField
    - StateMachineIssueCustomField
  - TextIssueCustomField
- IssueFolder
  - Project
  - WatchFolder
    - SavedQuery
    - Tag
      - IssueTag
- IssueKey
- IssueLink
- IssueLinkType
- IssueTimeTracking
- IssueVoters
- IssueWatcher
- IssueWatchers
- License
- LocaleDescriptor
- LocaleSettings
- Logo
- NotificationSettings
- NotificationsUserProfile
- OnlineUsers
- Organization
- ParsedCommand
- PeriodFieldFormat
- PeriodValue
- Permission
- ProjectColor
- ProjectCustomField
  - BundleProjectCustomField
    - BuildProjectCustomField
    - EnumProjectCustomField
    - OwnedProjectCustomField
    - StateProjectCustomField
    - UserProjectCustomField
    - VersionProjectCustomField
  - GroupProjectCustomField
  - PeriodProjectCustomField
  - SimpleProjectCustomField
    - TextProjectCustomField
- ProjectTimeTrackingSettings
- PullRequest
- PullRequestChange
- PullRequestState
- Reaction
- RestCorsSettings
- Role
- SearchSuggestions
- Sprint
- SprintsSettings
- StorageEntry
- Suggestion
- SwimlaneSettings
  - AttributeBasedSwimlaneSettings
  - IssueBasedSwimlaneSettings
- SwimlaneValue
- SystemSettings
- TagSharingSettings
- Telemetry
- TextFieldValue
- TimeTrackingUserProfile
- TimeZoneDescriptor
- User
  - Me
  - VcsUnresolvedUser
- UserGroup
  - AllUsersGroup
  - NestedGroup
  - ProjectTeam
  - RegisteredUsersGroup
- UserProfiles
- UserType
- VcsChange
- VcsServer
  - JenkinsServer
  - TeamcityServer
  - VcsHostingServer
    - BitBucketServer
    - BitbucketStandaloneServer
    - GitHubServer
    - GitLabServer
    - GiteaServer
    - GogsServer
    - SpaceServer
- Visibility
  - LimitedVisibility
  - UnlimitedVisibility
- WIPLimit
- WatchFolderSharingSettings
- WorkItemAttribute
- WorkItemAttributePrototype
- WorkItemAttributeValue
- WorkItemProjectAttribute
- WorkItemType
- WorkTimeSettings

REST API Reference[AccessScope](jetbrains__com__help__youtrack__devportal__api-entity-accessscope.md)

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

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