JIRA API get custom field description

Paul Malone

I cannot seem to find out how to get the 'description' of the custom field via the API.

Fabio Racobaldo _Catworkx_

Hi @Paul Malone ,

you can use the following rest api https://docs.atlassian.com/software/jira/docs/api/REST/8.22.4/#customFields-getCustomFields

The resonse contains the cf description 

Responses

EXAMPLE

{
    "<span>id</span>": <span>"customfield_10000"</span>,
    "<span>name</span>": <span>"New custom field"</span>,
    "<span>description</span>": <span>"Custom field for picking groups"</span>,
    "<span>type</span>": <span>"com.atlassian.jira.plugin.system.customfieldtypes:grouppicker"</span>,
    "<span>searcherKey</span>": <span>"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"
</span>}

 

Hope this helps,

Fabio