Create custom field

POST

/rest/api/3/field

Creates a custom field.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/rest/api/3/field' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Custom field for picking groups",
    "name": "New custom field",
    "searcherKey": "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
    "type": "com.atlassian.jira.plugin.system.customfieldtypes:grouppicker"
}'

Response Example

{"clauseNames":["cf[10101]","New custom field"],"custom":true,"id":"customfield_10101","key":"customfield_10101","name":"New custom field","navigable":true,"orderable":true,"schema":{"custom":"com.atlassian.jira.plugin.system.customfieldtypes:project","customId":10101,"type":"project"},"searchable":true,"untranslatedName":"New custom field"}

Request

Body Params application/json

Examples

Responses

🟢201Created

application/json

Returned if the custom field is created.

Body

🟠400Bad Request

Modified at 2025-07-16 07:18:01

Get fields

Get fields paginated