---
schema: rendered-html/v1
title: "IssueCustomField | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/api-entity-IssueCustomField.html
generated_at: 2026-06-11T14:50:20.560235+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](jetbrains__com__help__youtrack__devportal__api-entity-issuecomment.md)
- [IssueCountResponse](jetbrains__com__help__youtrack__devportal__api-entity-issuecountresponse.md)
- [IssueCustomField](api-entity-IssueCustomField.html)
- MultiValueIssueCustomField
- PeriodIssueCustomField
- SimpleIssueCustomField
- SingleValueIssueCustomField
- TextIssueCustomField
- [IssueFolder](jetbrains__com__help__youtrack__devportal__api-entity-issuefolder.md)
- [IssueKey](jetbrains__com__help__youtrack__devportal__api-entity-issuekey.md)
- [IssueLink](jetbrains__com__help__youtrack__devportal__api-entity-issuelink.md)
- [IssueLinkType](jetbrains__com__help__youtrack__devportal__api-entity-issuelinktype.md)
- [IssueTimeTracking](jetbrains__com__help__youtrack__devportal__api-entity-issuetimetracking.md)
- [IssueVoters](jetbrains__com__help__youtrack__devportal__api-entity-issuevoters.md)
- 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
4. [IssueCustomField](#0)

# IssueCustomField﻿

Last modified: 20 April 2026

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

Extended by:

- PeriodIssueCustomField
- SimpleIssueCustomField
- SingleValueIssueCustomField
- MultiValueIssueCustomField
- TextIssueCustomField

## 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`. |

- [IssueCustomField](/help/youtrack/devportal/api-entity-IssueCustomField.html)
- [Related Resources](/help/youtrack/devportal/api-entity-IssueCustomField.html#f9oe9c_6)
- [Attributes](/help/youtrack/devportal/api-entity-IssueCustomField.html#f9oe9c_9)

[IssueCountResponse](jetbrains__com__help__youtrack__devportal__api-entity-issuecountresponse.md)MultiValueIssueCustomField

- 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=c1f61b01-fe73-4dcb-88bc-380819393f24&bo=4&sid=452929b065a111f19a7fe7356f74a419&vid=aa3122f0648711f1a10d6d095e10fd87&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=1920&sh=1080&sc=24&tl=IssueCustomField%20%7C%20Developer%20Portal%20for%20YouTrack%20and%20Hub%20Documentation&p=https%3A%2F%2Fwww.jetbrains.com%2Fhelp%2Fyoutrack%2Fdevportal%2Fapi-entity-IssueCustomField.html&r=&lt=651&pt=1781189417886,60,60,,,2,2,2,2,2,,3,31,32,66,260,260,260,650,651,651&pn=0,0&evt=pageLoad&sv=2&asc=G&cdb=AQAS&rn=839067)

![](https://crawler.prototype.prolicht.digital/l/Cc5YLO)![](https://crawler.prototype.prolicht.digital/l/dIfJvA)
