How to use the maxResults API parameter for Jira Issue Search REST API | Jira (2024)

Platform notice: Server and Data Center only. This article only applies to Atlassian products on the Server and Data Center platforms.

Support for Server* products ended onFebruary 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

This article explains how to use themaxResultsparameter in the Jira Issue Search REST API. ThemaxResultsparameter is a query parameter used to limit the number of items returned in a Jira REST API response, and it is used to control pagination when retrieving large amounts of data. The article provides an example of how to use the max-results parameter to retrieve issues from Jira using JQL. It also highlights the importance of setting a reasonable value formaxResultsto avoid slow response times and high server load.

Jira Server and Jira Data Center

(While Jira Cloud has this parameter, there are other restrictions in place in Cloud that can limit its effective use, see JRACLOUD-67722 - Getting issue details... STATUS )

By default, the Jira Issue Search REST API returns a maximum of 50 items per response. If you want to retrieve more items, you can use themaxResultsparameter to increase the limit.

How to usemaxResultsin Jira Server and Jira Data Center

To use themaxResultsparameter in Jira, you need to append it to the end of the REST API endpoint URL, as shown in the example below:

http://jira.example.com/rest/api/2/search?jql=project%3DITSM&maxResults=50

In this example, we are using the /search endpoint to retrieve a list of issues from the ITSM project, and we have set themaxResultsparameter to 50. This means that the Jira REST API will return a maximum of 50 issues per project.

To access all of the Jira APIs, you can refer to the documentation provided athttps://docs.atlassian.com/software/jira/docs/api/REST/latest/.

How to use the maxResults API parameter for Jira Issue Search REST API | Jira (2024)

FAQs

How do I get more than 50 results from Jira rest API? ›

Solution. By default, the Jira Issue Search REST API returns a maximum of 50 items per response. If you want to retrieve more items, you can use the maxResults parameter to increase the limit.

What is the limit of maxResults in Jira user search? ›

For Jira Server, the default limit is 1000, and an Administrator can adjust the limit by changing the application property jira.search. views. default.

How to use JQL in Jira API? ›

There are two ways to encode a JQL query to make it URL-compatible.
  1. The first one is to perform a JQL search in Jira and copy the query from the browser's URL (after running the search). Example:
  2. The second option is to use the URL Encoding Smart Value. Note that this option can only be used in an automation rule.
Oct 4, 2023

What is the limit of results in REST API? ›

By default, when you perform a synchronous GET request with this API, the maximum number of objects returned is 500. Some GET APIs provide query parameters to help restrict the number of results, depending on the API.

How do I show more than 50 issues in Jira JQL? ›

Workaround: Navigate to System > Default User preferences and Change the Number of Issues displayed per Issue navigator page to 100. Once this is done, we can use the Advanced Issue Search to display 100 issues per page.

What is the maximum result in Jira search stable? ›

In Jira, there is a default limit of 1000 rows set on the number of issues that can be returned in the Issue Navigator. This is done to prevent unnecessary performance degradation. This default is set in the jira.search. stable.

Can Jira search more than 1000 issues? ›

Retrieving more than 1000 issues at once may result in an OutOfMemoryException for large result sets. This can cause database corruption or an application crash. Created with Sketch. As of Jira 8.2, the memory problems are less frequent, especially if not exporting all fields.

How to limit results in JQL? ›

To change the limit of issues retrieved by the Lookup action:
  1. In the upper-right corner of the screen, select Administration > System.
  2. Under Automation for Jira (the left-side panel), select Automation rules.
  3. In the More actions ... ...
  4. Specify the limit in the Lookup issues results limit field.
Aug 7, 2023

How do I write a JQL query in Jira? ›

A simple query in JQL (also known as a “clause”) consists of a field, followed by an operator, followed by one or more values or functions. Field – Fields are different types of information in the system. Jira fields include priority, fixVersion, issue type, etc. Operator – Operators are the heart of the query.

Can you use Jira smart values in JQL? ›

You can use smart values in JQL but you'll need to make sure it evaluates to a proper JQL. e.g. 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.

How to test JQL in Jira? ›

To try out JQL in your JIRA instance, you can:
  1. Click Issues > Search for issue.
  2. Click Edit (If you have a search in progress)
  3. Click Advanced Searching.

What format is Jira REST API output? ›

JIRA's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. Currently, the only supported reponse format is JSON.

How does Jira rest API work? ›

The Jira REST API enables you to interact with Jira programmatically. Use this API to build apps, script interactions with Jira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including the HTTP response codes and example requests and responses.

How do you expand REST API in Jira? ›

Expansion. The Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified in the request. This simplifies responses and minimizes network traffic. To expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded.

What is the return limit for Jira API? ›

While using JIra APIs it only returns 100 data in one call, but as per the API document, it can return 1000 records in one call.

How do I fetch more than 1000 records in Jira? ›

Use Jira's REST API: Jira's REST API allows you to export data in a structured format. You can use the API to retrieve a large amount of data and then use a script to process and export the data as needed.

How do I get more than 5000 items from Sharepoint list using REST API? ›

2 answers
  1. Initialize Variables: Set up the necessary variables and configurations. Define the CAML query.
  2. Create a Function to Fetch Items: Use the REST API to fetch items. Implement pagination by using the ListItemCollectionPositionNext property.
  3. Combine Results: Aggregate results from each paginated request.
Jul 11, 2024

Top Articles
Mullen Automotive, Inc. (MULN) Stock Forecast & Price Prediction 2025, 2030 | CoinCodex
KreditBee personal loan at Lowest Interest Rates | Apply Online Now
English Bulldog Puppies For Sale Under 1000 In Florida
Katie Pavlich Bikini Photos
Gamevault Agent
Pieology Nutrition Calculator Mobile
Hocus Pocus Showtimes Near Harkins Theatres Yuma Palms 14
Hendersonville (Tennessee) – Travel guide at Wikivoyage
Compare the Samsung Galaxy S24 - 256GB - Cobalt Violet vs Apple iPhone 16 Pro - 128GB - Desert Titanium | AT&T
Vardis Olive Garden (Georgioupolis, Kreta) ✈️ inkl. Flug buchen
Craigslist Dog Kennels For Sale
Things To Do In Atlanta Tomorrow Night
Non Sequitur
Crossword Nexus Solver
How To Cut Eelgrass Grounded
Pac Man Deviantart
Alexander Funeral Home Gallatin Obituaries
Energy Healing Conference Utah
Geometry Review Quiz 5 Answer Key
Hobby Stores Near Me Now
Icivics The Electoral Process Answer Key
Allybearloves
Bible Gateway passage: Revelation 3 - New Living Translation
Yisd Home Access Center
Pearson Correlation Coefficient
Home
Shadbase Get Out Of Jail
Gina Wilson Angle Addition Postulate
Celina Powell Lil Meech Video: A Controversial Encounter Shakes Social Media - Video Reddit Trend
Walmart Pharmacy Near Me Open
Marquette Gas Prices
A Christmas Horse - Alison Senxation
Ou Football Brainiacs
Access a Shared Resource | Computing for Arts + Sciences
Vera Bradley Factory Outlet Sunbury Products
Pixel Combat Unblocked
Movies - EPIC Theatres
Cvs Sport Physicals
Mercedes W204 Belt Diagram
Mia Malkova Bio, Net Worth, Age & More - Magzica
'Conan Exiles' 3.0 Guide: How To Unlock Spells And Sorcery
Teenbeautyfitness
Where Can I Cash A Huntington National Bank Check
Topos De Bolos Engraçados
Sand Castle Parents Guide
Gregory (Five Nights at Freddy's)
Grand Valley State University Library Hours
Hello – Cornerstone Chapel
Stoughton Commuter Rail Schedule
Nfsd Web Portal
Selly Medaline
Latest Posts
Article information

Author: Msgr. Benton Quitzon

Last Updated:

Views: 5856

Rating: 4.2 / 5 (43 voted)

Reviews: 90% of readers found this page helpful

Author information

Name: Msgr. Benton Quitzon

Birthday: 2001-08-13

Address: 96487 Kris Cliff, Teresiafurt, WI 95201

Phone: +9418513585781

Job: Senior Designer

Hobby: Calligraphy, Rowing, Vacation, Geocaching, Web surfing, Electronics, Electronics

Introduction: My name is Msgr. Benton Quitzon, I am a comfortable, charming, thankful, happy, adventurous, handsome, precious person who loves writing and wants to share my knowledge and understanding with you.