Custom Fields

Resource	/api/admin/customFieldSettings/customFields
Returned entity	CustomField. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of CustomFields. `POST`: Add a New CustomField.
Supported sub-resources	/api/admin/customFieldSettings/customFields/{fieldID}: Operations with Specific CustomField /api/admin/customFieldSettings/customFields/{fieldID}/fieldDefaults: Custom Field Defaults /api/admin/customFieldSettings/customFields/{fieldID}/instances: Project Custom Fields

CustomField attributes

Represents custom field in YouTrack.

This table describes attributes of the CustomField entity.

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

Field	Type	Description
name	String	The name of the custom field. `Can be null`.
localizedName	String	If set, then this value is used for field presentation in UI. `Can be null`.
fieldType	FieldType	Type of the custom field.
isAutoAttached	Boolean	If true, then field will be automatically attached 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	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	Project-related settings. May contain different values for custom fields of different types

Get all available custom fields.

GET /api/admin/customFieldSettings/customFields?{fields}&{$top}&{$skip}

Parameter	Type	Description
fields	string	A list of CustomField 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.

Create a new custom field. Name and field type are required.

POST /api/admin/customFieldSettings/customFields?{fields}

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

Last modified: 8 July 2019