How to apply the limit filter in Bitbucket Server and Datacenter ReST API and query more than the max limit of 1000 results.
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 on February 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
Summary
By default Bitbucket Server and Datacenter ReST API returns 25 results, which can be increased to 1000 using the limit filter. However, for some customers this limit may not be enough, to get the complete result set follow the steps in the solution section of the article.
Environment
Bitbucket Server and Datacenter 6.x, 7.x,8.x,9.x
Solution
Case 1:
To fetch 1000 results, append ?limit=1000 at the end of the Bitbucket Server and Datacenter ReST resource.
Example:
curl -H "Content-Type:application/json" --user <Bitbucket admin username>:<password> -H "Accept:application/json" -X GET "<BITBUCKET_BASE_URL>/rest/api/1.0/admin/users?limit=1000"Note: If you are using cURL to run the API call enclose the entire ReST resource in double quotes, in the case of Postman it is not mandatory.
Case 2:
To fetch all the results
- Run the API to get first 1000 results
- Note the "nextPageStart" value from the results
- set the number from "nextPageStart" to start parameter
?start=1&limit=1000
curl -H "Content-Type:application/json" --user <Bitbucket admin username>:<password> -H "Accept:application/json" -X GET "<BITBUCKET_BASE_URL>/rest/api/1.0/admin/users?start=1&limit=1000"