---
schema: rendered-html/v1
title: "Project | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/api-entity-Project.html
generated_at: 2026-06-11T14:53:33.609800+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
- AccessScope
- 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
- [Project](api-entity-Project.html)
- WatchFolder
- IssueKey
- IssueLink
- IssueLinkType
- IssueTimeTracking
- IssueVoters
- IssueWatcher
- IssueWatchers
- License
- LocaleDescriptor
- LocaleSettings
- Logo
- NotificationSettings
- NotificationsUserProfile
- OnlineUsers
- Organization
- ParsedCommand
- PeriodFieldFormat
- PeriodValue
- [Permission](jetbrains__com__help__youtrack__devportal__api-entity-permission.md)
- [ProjectColor](jetbrains__com__help__youtrack__devportal__api-entity-projectcolor.md)
- [ProjectCustomField](jetbrains__com__help__youtrack__devportal__api-entity-projectcustomfield.md)
- [ProjectTimeTrackingSettings](jetbrains__com__help__youtrack__devportal__api-entity-projecttimetrackingsettings.md)
- [PullRequest](jetbrains__com__help__youtrack__devportal__api-entity-pullrequest.md)
- [PullRequestChange](jetbrains__com__help__youtrack__devportal__api-entity-pullrequestchange.md)
- 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
4. IssueFolder
5. [Project](#0)

# Project﻿

Last modified: 31 March 2026

Represents a YouTrack project.

## Related Resources﻿

Below you can find the list of resources that let you work with this entity.

- Projects
- Issue Project

Extends IssueFolder

## Attributes﻿

This table describes attributes of the `Project` entity.

- To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.
- To update an attribute, provide it in the body of a POST request.

| Field | Type | Description |
| --- | --- | --- |
| id | String | The database ID of the project. `Read-only`. |
| archived | Boolean | If the project is currently archived, this property is `true`. |
| createdBy | User | The user who created the project. `Can be null`. |
| customFields | [ProjectCustomField](jetbrains__com__help__youtrack__devportal__api-entity-projectcustomfield.md) | The set of custom fields that are available in the project. |
| description | String | The description of the project as shown on the project profile page. `Can be null`. |
| fromEmail | String | The email address that is used to send notifications for the project. If a 'From' address is not set for the project, the default 'From' address for the YouTrack server is returned. |
| iconUrl | String | The URL of the icon of the project. `Read-only`. `Can be null`. |
| issues | Array of Issues | A list of all issues that belong to the project. |
| leader | User | The user who is set as the project owner. |
| name | String | The name of the project. |
| replyToEmail | String | The email address that is used as the reply email to send notifications for the project. If it is not set for the project, the default address for the YouTrack server is returned. `Can be null`. |
| shortName | String | The ID of the project. This short name is also a prefix for an issue ID. |
| startingNumber | Long | Starting number for issues in project. This property can be set only during creation of the new project. |
| team | [ProjectTeam](jetbrains__com__help__youtrack__devportal__api-entity-projectteam.md) | Read-only user group representing all members of the project team. `Read-only`. |
| template | Boolean | If `true`, this project is a template. |

- [Project](/help/youtrack/devportal/api-entity-Project.html)
- [Related Resources](/help/youtrack/devportal/api-entity-Project.html#-ulbkcl_3)
- [Attributes](/help/youtrack/devportal/api-entity-Project.html#-ulbkcl_5)

IssueFolderWatchFolder

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

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