v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue custom field contexts

Get custom field contexts default values

Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
The returned object depends on type of the custom field:

  • CustomFieldContextDefaultValueDate (type datepicker) for date fields.
  • CustomFieldContextDefaultValueDateTime (type datetimepicker) for date-time fields.
  • CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons.
  • CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes.
  • CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists.
  • CustomFieldContextSingleUserPickerDefaults (type single.user.select) for single users.
  • CustomFieldContextDefaultValueMultiUserPicker (type multi.user.select) for user lists.
  • CustomFieldContextDefaultValueSingleGroupPicker (type grouppicker.single) for single choice group pickers.
  • CustomFieldContextDefaultValueMultipleGroupPicker (type grouppicker.multiple) for multiple choice group pickers.
  • CustomFieldContextDefaultValueURL (type url) for URLs.
  • CustomFieldContextDefaultValueProject (type project) for project pickers.
  • CustomFieldContextDefaultValueFloat (type float) for floats (floating-point numbers).
  • CustomFieldContextDefaultValueLabels (type labels) for labels.
  • CustomFieldContextDefaultValueTextField (type textfield) for text fields.
  • CustomFieldContextDefaultValueTextArea (type textarea) for text area fields.
  • CustomFieldContextDefaultValueReadOnly (type readonly) for read only (text) fields.
  • CustomFieldContextDefaultValueMultipleVersion (type version.multiple) for single choice version pickers.
  • CustomFieldContextDefaultValueSingleVersion (type version.single) for multiple choice version pickers.

Forge custom fields types are also supported, returning:

  • CustomFieldContextDefaultValueForgeStringFieldBean (type forge.string) for Forge string fields.
  • CustomFieldContextDefaultValueForgeMultiStringFieldBean (type forge.string.list) for Forge string collection fields.
  • CustomFieldContextDefaultValueForgeObjectFieldBean (type forge.object) for Forge object fields.
  • CustomFieldContextDefaultValueForgeDateTimeFieldBean (type forge.datetime) for Forge date-time fields.
  • CustomFieldContextDefaultValueForgeGroupFieldBean (type forge.group) for Forge group fields.
  • CustomFieldContextDefaultValueForgeMultiGroupFieldBean (type forge.group.list) for Forge group collection fields.
  • CustomFieldContextDefaultValueForgeNumberFieldBean (type forge.number) for Forge number fields.
  • CustomFieldContextDefaultValueForgeUserFieldBean (type forge.user) for Forge user fields.
  • CustomFieldContextDefaultValueForgeMultiUserFieldBean (type forge.user.list) for Forge user collection fields.

Deprecated: This API is deprecated and will be removed in October 2026. A replacement API that supports multiple default values per issue type within a context is coming soon. See the deprecation notice CHANGE-3082 for more details.

Permissions required: Administer Jira global permission.

get/rest/api/3/field/{fieldId}/context/defaultValue

Path parameters

fieldIdstring required

The ID of the custom field, for example customfield\_10000.

Query parameters

contextIdinteger[]

The IDs of the contexts.

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.