# CustomField

Represents a custom field in YouTrack.

## Related Resources

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

* [Custom Fields](resource-api-admin-customFieldSettings-customFields.html)

## Attributes

This table describes attributes of the `CustomField` 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. `Read-only`.  |
|  name  |  String  |  The name of the custom field.  |
|  localizedName  |  String  |  If set, then this value is used for the field presentation in UI. `Can be null`.  |
|  fieldType  |  [FieldType](api-entity-FieldType.html)  |  The type of the custom field.  |
|  isAutoAttached  |  Boolean  |  If `true`, then the field will be automatically attached to new projects.  |
|  isDisplayedInIssueList  |  Boolean  |  If `true`, the field is visible in the Issues list by default.  |
|  ordinal  |  Int  |  Number of the field.  |
|  aliases  |  String  |  A comma-separated list of aliases that can be used in search and commands. `Can be null`.  |
|  fieldDefaults  |  [CustomFieldDefaults](api-entity-CustomFieldDefaults.html)  |  Default project-related settings for the custom field. May contain different values for custom fields of different types. `Read-only`.  |
|  hasRunningJob  |  Boolean  |  Indicates whether a background job is running for this field. In this case, some field operations may be temporary unavailable. `Read-only`.  |
|  isUpdateable  |  Boolean  |  Indicates whether the current user has permissions to update this field. `Read-only`.  |
|  instances  |  [Array of ProjectCustomFields](api-entity-ProjectCustomField.html)  |  Project-related settings. May contain different values for custom fields of different types  |