Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 
  • Community
  • Q&A
  • Jira
  • Questions
  • The new issue search API is returning description field with JSON/ADF Format instead of plaintext.

The new issue search API is returning description field with JSON/ADF Format instead of plaintext.

genuser_service October 15, 2025

The new API for issue i.e. GET /rest/api/3/search/jql 

is returning the response for description field in JSON or ADF format, instead of plaintext/string.

On the below article the example response shows string value but its giving JSON format value. Why is that so?
Is there a way or query param which will help in getting the description field in string format.

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-get

1 answer

1 vote
Marc - Devoteam
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
October 15, 2025

HI @genuser_service 

The output is always in JSON format, but you can use the values, as they are text.

The old enpoint also provided outputin JSON format.

How do you want to use the output or what is your need with from the response of the API call.

genuser_service October 15, 2025

I want description field for example to have a string value instead of JSON(ADF format) value.
I tried using GET /rest/api/2/search/jql  which worked and gave string value for description field. But I am refraining the use because there's no documented record of v2.

GET /rest/api/3/search/jql  --> This one is documented.

Marc - Devoteam
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
October 15, 2025

Hi @genuser_service 

This is not an answer on what I asked,

The output markup of an API call is always JSON and the value of the description field is always text, this is not JSON.

The old search API endpoint is deprecated and activly removed so this is not uasble anymore.

 

Like Ferreira Andre V likes this

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
FREE
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events