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; } } }

Advanced JIRA search from REST v3 returns 200 code with empty data

Garrett Kaufmann

Hi all,

I am migrating our application to leverage the enhanced JIRA search endpoint (/rest/api/3/search/jql). We previously used the now deprecated /rest/api/3/search/ endpoint which gave us responses matching the corresponding results from the same JQL query in the JIRA web search window. We currently receive 200 status from hitting the advanced search endpoint, but we get no data for all queries. Even the most basic queries return an empty issues list. We know these queries are valid since they generate results in the web page search still. Our test setup is that of the JQL advanced search v3 API docs demo, and given the 200 status I know it is not a matter of invalid credentials.

This is the response no matter what the query is- and we verify all queries with a search on the web page:

{ "isLast": true, "issues": [] }

Accepted answers

All comments

Vitalii Rybka

I think the issue might be with the fields or expand parameters - in the v3 API you often get an empty array if no fields are specified. Try adding something like fields=summary,key (or whichever fields you need), and the response should start returning data.

Garrett Kaufmann

Hey Vitalii,

We are already requesting fields. This is the request payload setup for our test:

url = f"{JIRA_BASE_URL}/rest/api/3/search/jql"

auth = HTTPBasicAuth(JIRA_USER_EMAIL, JIRA_API_TOKEN)

headers = {

"Accept": "application/json"

}

query = {

'jql': jql,

"maxResults": 50,

"fields": "id,key,summary,status,description"

}

response = requests.request(

"GET",

url,

headers=headers,

params=query,

auth=auth

)

Vitalii Rybka

@Garrett Kaufmann, I would like to clarify. Do you use Forge env or Node.js env?

According to the docs, there are several important notes:

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.
Permissions required: Issues are included in the response where the user has:
- Browse projects project permission for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
OAuth 2.0 scopes required:
- Classic: `read:jira-work`
- Granular: `read:issue-details:jira, read:audit-log:jira, read:avatar:jira, read:field-configuration:jira, read:issue-meta:jira`
Connect app scope required: `READ`

Garrett Kaufmann

We are using the requests library for HTTP in Python 3.10.12. We are using a generic token with no permission restrictions.

Welcome!

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

Quick Links

Find more posts tagged with

jira

cloud

jira-cloud