---
schema: rendered-html/v1
title: "Issue Custom Fields | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-issues-issueID-customFields.html
generated_at: 2026-06-11T15:12:45.671161+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
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- [Issue Tag](jetbrains__com__help__youtrack__devportal__resource-api-issuetags.md)
- Issues
- Operations with Specific Issue
- Sub-resources
- [Issue Activity Items](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-activities.md)
- [Activity Cursor Page](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-activitiespage.md)
- [Issue Attachments](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-attachments.md)
- [Issue Comments](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-comments.md)
- [Issue Custom Fields](resource-api-issues-issueID-customFields.html)
- Operations with Specific IssueCustomField
- [Issue Links](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-links.md)
- [Issue Project](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-project.md)
- [Issue Sprints](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-sprints.md)
- [Tags](jetbrains__com__help__youtrack__devportal__resource-api-issues-issueid-tags.md)
- Issue Time Tracking
- Issue VCS Changes and Pull Requests
- 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. Issues
5. [Sub-resources](#0)
6. [Issue Custom Fields](#0)

# Issue Custom Fields﻿

Last modified: 20 April 2026

This resource lets you work with custom fields of the issue.

| Resource | ``` /api/issues/{issueID}/customFields ``` |
| --- | --- |
| Returned entity | IssueCustomField. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-issues-issueID-customFields.html#IssueCustomField-supported-fields) section. |
| Supported methods | - `GET`: [Read a List of IssueCustomFields](/help/youtrack/devportal/resource-api-issues-issueID-customFields.html#get_all-IssueCustomField-method). |

## IssueCustomField attributes﻿

Represents a custom field along with its value in the particular issue.

The `IssueCustomField` is an abstract ancestor for all types of custom fields in issues. The actual type of the custom field depends on field settings in the particular project.

Each `IssueCustomField` entity, regardless of its type, has the following attributes:

- `$type` — the unique type of the issue custom field. You must provide this attribute when you update the custom field in an issue.
- `id` — the entity ID of the issue custom field.
- `name` — the string name of the custom field.
- `projectCustomField` — the reference to the settings of the custom field in the project.
- `value` — the value assigned to the custom field in the issue. Depending on the type of the field, this attribute can store a single value or an array of values.

### Related Resources﻿

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

- Issue Custom Fields

### Attributes﻿

This table describes attributes of the `IssueCustomField` 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 ID of the custom field in the issue. `Read-only`. |
| name | String | The name of the custom field. `Read-only`. |
| projectCustomField | ProjectCustomField | Reference to the custom field settings for the particular project. `Read-only`. |
| value | Possible value types depend on the custom field type. This property can contain a primitive value, a single entity value, or an array of entity values.   - String - Integer - Float - Date and Time - Date - StateBundleElement - BuildBundleElement - VersionBundleElement - OwnedBundleElement - EnumBundleElement - UserGroup - User | The value assigned to the custom field in the issue.  Depending on the type of the field, this attribute can store a single value or an array of values.  `Read-only`. `Can be null`. |

## Read a List of IssueCustomFields﻿

Get the list of available custom fields of the issue.

### Request syntax﻿

GET /api/issues/{issueID}/customFields?{fields}&{$top}&{$skip}

| null | The database ID of IssueCustomField |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of IssueCustomField attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |
| $skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
| $top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.  The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |

### Sample﻿

#### Sample request﻿

https://example.youtrack.cloud/api/issues/2-7/fields?fields=id,name,value(id,name)

#### Sample response body﻿

[
  {
    "value": {
      "name": "Major",
      "id": "67-2",
      "$type": "EnumBundleElement"
    },
    "name": "Priority",
    "id": "92-1",
    "$type": "SingleEnumIssueCustomField"
  },
  {
    "value": {
      "name": "Bug",
      "id": "67-5",
      "$type": "EnumBundleElement"
    },
    "name": "Type",
    "id": "92-2",
    "$type": "SingleEnumIssueCustomField"
  },
  {
    "value": {
      "name": "Fixed",
      "id": "69-7",
      "$type": "StateBundleElement"
    },
    "name": "State",
    "id": "92-3",
    "$type": "StateIssueCustomField"
  },
  {
    "value": {
      "name": "Jane Doe",
      "id": "1-3",
      "$type": "User"
    },
    "name": "Assignee",
    "id": "94-0",
    "$type": "SingleUserIssueCustomField"
  },
  {
    "value": null,
    "name": "Subsystem",
    "id": "92-0",
    "$type": "SingleOwnedIssueCustomField"
  },
  {
    "value": [
      {
        "name": "2019.1",
        "id": "133-19",
        "$type": "VersionBundleElement"
      }
    ],
    "name": "Fix versions",
    "id": "92-4",
    "$type": "MultiVersionIssueCustomField"
  },
  {
    "value": [],
    "name": "Affected versions",
    "id": "92-5",
    "$type": "MultiVersionIssueCustomField"
  },
  {
    "value": null,
    "name": "Fixed in build",
    "id": "92-6",
    "$type": "SingleBuildIssueCustomField"
  }
]

- [Issue Custom Fields](/help/youtrack/devportal/resource-api-issues-issueID-customFields.html)
- [IssueCustomField attributes](/help/youtrack/devportal/resource-api-issues-issueID-customFields.html#IssueCustomField-supported-fields)
- [Read a List of IssueCustomFields](/help/youtrack/devportal/resource-api-issues-issueID-customFields.html#get_all-IssueCustomField-method)

Operations with Specific ReactionOperations with Specific IssueCustomField

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

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

![](https://bat.bing.com/action/0?ti=5220035&tm=gtm002&Ver=2&mid=9658d581-302d-4540-8d6f-4b5aa6d55079&bo=4&sid=452929b065a111f19a7fe7356f74a419&vid=aa3122f0648711f1a10d6d095e10fd87&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1920&sh=1080&sc=24&tl=Issue%20Custom%20Fields%20%7C%20Developer%20Portal%20for%20YouTrack%20and%20Hub%20Documentation&p=https%3A%2F%2Fwww.jetbrains.com%2Fhelp%2Fyoutrack%2Fdevportal%2Fresource-api-issues-issueID-customFields.html&r=&lt=1026&pt=1781190761916,41,41,,,3,3,3,3,3,,3,34,35,45,247,247,247,1024,1025,1026&pn=0,0&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=902757)
