---
schema: rendered-html/v1
title: "Operations with Specific Project | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/operations-api-admin-projects.html
generated_at: 2026-06-11T15:05:16.951975+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
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- [Operations with Specific Project](operations-api-admin-projects.html)
- Sub-resources
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- Issues
- Issue Count
- Permissions
- Roles
- Saved Queries
- Search Suggestions
- Tags
- Users
- My User Profile
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. Projects
5. [Operations with Specific Project](#0)

# Operations with Specific Project﻿

Last modified: 31 March 2026

This resource provides access to projects.

| Resource | ``` /api/admin/projects/{projectID} ``` |
| --- | --- |
| Returned entity | Project. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/operations-api-admin-projects.html#Project-supported-fields) section. |
| Supported methods | - `GET`: [Read a Specific Project](/help/youtrack/devportal/operations-api-admin-projects.html#get-Project-method). - `POST`: [Update a Specific Project](/help/youtrack/devportal/operations-api-admin-projects.html#update-Project-method). - `DELETE`: [Delete a Specific Project](/help/youtrack/devportal/operations-api-admin-projects.html#delete-Project-method). |

## Project attributes﻿

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 | 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 | Read-only user group representing all members of the project team. `Read-only`. |
| template | Boolean | If `true`, this project is a template. |

## Read a Specific Project﻿

Get the settings of the specific project.

### Required permissions﻿

Requires permissions: Read Project Basic or Update Project

### Request syntax﻿

GET /api/admin/projects/{projectID}?{fields}

| {projectID} | ID of the project. To identify the project, you can use either its database entity ID or the short name. |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/admin/projects/0-6?fields=id,name,timeTrackingEnabled,shortName,leader(login,name,id),description,createdBy(login,name,id)

#### Sample response body﻿

{
  "description": "A project created using REST API",
  "leader": {
    "login": "root",
    "name": "John Smith",
    "id": "1-1",
    "$type": "User"
  },
  "shortName": "RP",
  "createdBy": {
    "login": "john.doe",
    "name": "John Doe",
    "id": "1-2",
    "$type": "User"
  },
  "name": "Rest Project",
  "id": "0-6",
  "$type": "Project"
}

## Update a Specific Project﻿

Update settings of a project with a specific ID.

### Required permissions﻿

Requires permissions: Update Project

### Request syntax﻿

POST /api/admin/projects/{projectID}?{fields}

| {projectID} | ID of the project. To identify the project, you can use either its database entity ID or the short name. |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/admin/projects/0-6?fields=id,name,timeTrackingEnabled,shortName,leader(login,name,id),description,createdBy(login,name,id)

#### Sample request body﻿

{
  "leader":{"id":"1-1"},
  "description":"A project created using REST API"
}

#### Sample response body﻿

{
  "description": "A project created using REST API",
  "leader": {
    "login": "root",
    "name": "John Smith",
    "id": "1-1",
    "$type": "User"
  },
  "shortName": "RP",
  "createdBy": {
    "login": "john.doe",
    "name": "John Doe",
    "id": "1-2",
    "$type": "User"
  },
  "name": "Rest Project",
  "id": "0-6",
  "$type": "Project"
}

## Delete a Specific Project﻿

Delete a project with specific ID.

### Request syntax﻿

DELETE /api/admin/projects/{projectID}

| {projectID} | ID of the project. To identify the project, you can use either its database entity ID or the short name. |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

Identify the target project by its entity ID. For a successful request, server returns 200 OK code and an empty response payload.

#### Sample request﻿

https://example.youtrack.cloud/api/admin/projects/0-15

- [Operations with Specific Project](/help/youtrack/devportal/operations-api-admin-projects.html)
- [Project attributes](/help/youtrack/devportal/operations-api-admin-projects.html#Project-supported-fields)
- [Read a Specific Project](/help/youtrack/devportal/operations-api-admin-projects.html#get-Project-method)
- [Update a Specific Project](/help/youtrack/devportal/operations-api-admin-projects.html#update-Project-method)
- [Delete a Specific Project](/help/youtrack/devportal/operations-api-admin-projects.html#delete-Project-method)

ProjectsProject Articles

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

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