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 [Herzum]]

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

{
    "id": "customfield_10000",
    "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"
}

Hope this helps,

Fabio