rest api: where do I find list of searcher classes?

Searching on a created custom field using jql gives error:

error  "Field 'cf[10024]' is not searchable, it is only sortable."

I understand this to be result of not defining a searcher for the field, so where do I find a list of available searchers?

The field was created with:

"type": "com.atlassian.jira.plugin.system.customfieldtypes:textfield"


I have found field type definitions here:

By the way, the table is missing :textfield - which I am using for a simple text field, I just need to find the searcher for it.  (I'm guessing the class is  TextSearcher, just need to know how to define it when creating the field)




2 answers

This widget could not be displayed.
Alexey Matveev Community Champion Nov 06, 2017


Navigate to the Custom Fields page, locate the desired custom field and choose cog icon > Edit.

You can read more here:

Unfortunately that does not help as we need to configure as much as possible using the REST API without having a user log in to the JIRA web app.


Somewhere on my searches, I found example of creating a custom field, and there is a seacherKey field (here:


    "name": "New custom field",
    "description": "Custom field for picking groups",
    "type": "com.atlassian.jira.plugin.system.customfieldtypes:grouppicker",
    "searcherKey": "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"

- this is what I believe I am missing - and hence asking for the values of type and searcherKey for all supported field types.


I have found Javadoc for custom fields and it is possible the value is the name of the class, but all in lower case, so it may be a case of try it and see what happens.

This widget could not be displayed.

After a bit of guesswork, we have success!

create custom field as below.


    "name": "test-for-search",
    "description": "Custom field for testing search",
    "type": "com.atlassian.jira.plugin.system.customfieldtypes:textfield",
    "searcherKey": "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher"


Suggest an answer

Log in or Sign up to answer
Atlassian Summit 2018

Meet the community IRL

Atlassian Summit is an excellent opportunity for in-person support, training, and networking.

Learn more
Community showcase
Posted yesterday in New to Jira

Are you planning to trial, or are currently trialling Jira Software? - We want to talk to you!

Hello! I'm Rayen, a product manager at Atlassian. My team and I are working hard to improve the trial experience for Jira Software Cloud. We are interested in   talking to 20 people planning t...

64 views 1 0
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you