Jira Software REST API: Essential Parameters for Custom Field Creation
Platform notice: Server and Data Center only. This article only applies to Atlassian products on the Server and Data Center platforms.
Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
Currently, in the Jira Software REST API there is one endpoint to create custom fields: POST /rest/api/2/field.
However, knowing the correct value for parameters type and searcherKey for each different custom field* that comes out-of-the-box in Jira Software can be challenging.
(*) Please note that the information below is intended to help create Jira Software custom fields, custom fields coming from additional plugins, or 3rd party plugins will not be listed.
Environment
All versions
Solution
Here is a table with the information required for every custom field that comes out of the box with Jira Software.
| Custom field name | Parameters |
|---|---|
| Checkboxes | Type: com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher UI Search Template: Multi Select Searcher |
| Date Picker | Type: com.atlassian.jira.plugin.system.customfieldtypes:datepicker Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:daterange UI Search Template: Date Range Picker |
| Date Time Picker | Type: com.atlassian.jira.plugin.system.customfieldtypes:datetime Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:datetimerange UI Search Template: Date Time Range Picker |
| Development Summary | Type: com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary Searcher key: com.atlassian.jira.plugins.jira-development-integration-plugin:devsummarysearcher UI Search Template: Dev Summary Searcher |
| Global Rank | Type: com.pyxis.greenhopper.jira:gh-lexo-rank Searcher key: com.pyxis.greenhopper.jira:gh-lexo-rank-searcher UI Search Template: Jira Software Global Rank Searcher |
Group Picker (multiple groups) | Type: com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher UI Search Template: Group Picker Searcher |
Group Picker (single group) | Type: com.atlassian.jira.plugin.system.customfieldtypes:grouppicker Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher UI Search Template: Group Picker Searcher |
Hidden Job Switch | Type: com.atlassian.jirafisheyeplugin:hiddenjobswitch Searcher key: com.atlassian.jirafisheyeplugin:jobsearcher UI Search Template: Job Searcher |
Jira Released Version History | Type: com.pyxis.greenhopper.jira:greenhopper-releasedmultiversionhistory Searcher key: com.pyxis.greenhopper.jira:versionsearcher UI Search Template: Version Dropdown Searcher |
Job Checkbox | Type: com.atlassian.jirafisheyeplugin:jobcheckbox Searcher key: com.atlassian.jirafisheyeplugin:jobsearcher UI Search Template: Job Searcher |
Labels | Type: com.atlassian.jira.plugin.system.customfieldtypes:labels Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher UI Search Template: Labels Searcher |
Number Field | Type: com.atlassian.jira.plugin.system.customfieldtypes:float Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:exactnumber UI Search Template: Number Searcher |
Original Story Points | Type: com.atlassian.jpo:jpo-custom-field-original-story-points Searcher key: com.atlassian.jpo:jpo-custom-field-original-story-points-searcher UI Search Template: Original Story Points Searcher |
Project Picker (single project) | Type: com.atlassian.jira.plugin.system.customfieldtypes:project Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher UI Search Template: Project Dropdown Searcher |
Radio Buttons | Type: com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher UI Search Template: Multi Select Searcher |
Select List (cascading) | Type: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher UI Search Template: Cascading Select Searcher |
Select List (multiple choices) | Type: com.atlassian.jira.plugin.system.customfieldtypes:multiselect Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher UI Search Template: Multi Select Searcher |
Select List (single choice) | Type: com.atlassian.jira.plugin.system.customfieldtypes:select Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher UI Search Template: Multi Select Searcher |
Text Field (multi-line) | Type: com.atlassian.jira.plugin.system.customfieldtypes:textarea Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:textsearcher UI Search Template: Free Text Searcher |
Text Field (read only) | Type: com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:textsearcher UI Search Template: Free Text Searcher |
Text Field (single line) | Type: com.atlassian.jira.plugin.system.customfieldtypes:textfield Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:textsearcher UI Search Template: Free Text Searcher |
URL Field | Type: com.atlassian.jira.plugin.system.customfieldtypes:url Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher UI Search Template: Exact Text Searcher |
User Picker (multiple users) | Type: com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher UI Search Template: User Picker & Group Searcher |
User Picker (single user) | Type: com.atlassian.jira.plugin.system.customfieldtypes:userpicker Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher UI Search Template: User Picker & Group Searcher |
Version Picker (multiple versions) | Type: com.atlassian.jira.plugin.system.customfieldtypes:multiversion Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher UI Search Template: Version Dropdown Searcher |
Version Picker (single version) | Type: com.atlassian.jira.plugin.system.customfieldtypes:version Searcher key: com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher UI Search Template: Version Dropdown Searcher |