nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to get a list of all values of a dropdown field using jira rest api or jql

Shilpy Rana

I want to get the list of all the values of a dropdown field using jql.

For example - There is a dropdown field 'A' having options 1,2,3 then in the response of my query or api I want the list(or a json response having all the values) - [1,2,3]

Additional Info -
I do not have admin rights

Accepted answers

Charlie Misonne

Try this API endpoint:

Option 1

https://<your-tenant>.atlassian.net/rest/api/2/jql/autocompletedata/suggestions?fieldName=<field name>

It will return the list of possible values for the field. These are the same values you'll see in the JQL autocomplete suggestions.

Documentation on https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-rest-api-2-jql-autocompletedata-suggestions-get

Option 2

This is probably easier. But if you are not an admin you'll only see the options for the project you have access too, which is probably enough for you.

https://<your-tenant>/rest/api/2/customFieldOption/<field ID>

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-custom-field-options/#api-rest-api-2-customfieldoption-id-get

All comments

Charlie Misonne

Try this API endpoint:

Option 1

https://<your-tenant>.atlassian.net/rest/api/2/jql/autocompletedata/suggestions?fieldName=<field name>

It will return the list of possible values for the field. These are the same values you'll see in the JQL autocomplete suggestions.

Documentation on https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-rest-api-2-jql-autocompletedata-suggestions-get

Option 2

This is probably easier. But if you are not an admin you'll only see the options for the project you have access too, which is probably enough for you.

https://<your-tenant>/rest/api/2/customFieldOption/<field ID>

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-custom-field-options/#api-rest-api-2-customfieldoption-id-get

Shilpy Rana

Thankyou so much for your reply!

Option 1 worked for me and I am getting the required output.

For Option 2, I was getting 404, I was using the customfield_XXXXX type of id, as <field ID> is it correct or did I do something wrong?

Charlie Misonne

I'm sorry, option 2 is not valid.

I was confused but it only returns 1 option of the custom field where the ID is the ID of the option. So not what you are looking for.

I guess you'll have to go with option 1 :-)

Shilpy Rana

option 1 is not giving the full list, do I need to give some other parameter to get full list

Andrew Boeger_yis4oq

I went through this same headache today, but found the API to solve this problem!

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-get

If you're wondering "how do I get the context ID" ... I did too. Assuming you're an admin, go to the field admin page where you'd add/edit the options for the custom field you're working on.

Now look to the URL... you will see...

....fieldConfigSchemeId=10240&fieldConfigId=10240...

In my case, 10240 is the context ID. Good luck!

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

custom-field

jira

rest-api

jql