Skip to content

Commit ee5047f

Browse files
Document per_page max and silent clamping of oversized values (#45189)
Co-authored-by: Sharra-writes <sharra-writes@github.com>
1 parent 2ac96df commit ee5047f

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ The URLs in the `link` header use query parameters to indicate which page of res
6666

6767
If an endpoint supports the `per_page` query parameter, then you can control how many results are returned on a page. For more information about query parameters see [AUTOTITLE](/rest/using-the-rest-api/getting-started-with-the-rest-api#query-parameters).
6868

69+
For most endpoints, the maximum value of `per_page` is `100`. If you specify a value greater than the maximum, {% data variables.product.company_short %} does not return an error. Instead, the value is automatically reduced to the maximum, and the response includes no more than the maximum number of results per page. Because the request still succeeds, you may receive fewer results than you expect without any indication that the `per_page` value was reduced. To confirm the default and maximum `per_page` values for an endpoint, see the reference documentation for that endpoint.
70+
6971
For example, this request uses the `per_page` query parameter to return two items per page:
7072

7173
```shell

0 commit comments

Comments
 (0)