Limiting API results

The ReadMe API uses pagination on those endpoints that return lists. There are currently three endpoints that return lists:

Requests that return multiple items will be paginated to 10 items by default. If you want to return multiple pages, you can use the page query parameter. You can also set a custom page size up to 100 with the perPage query parameter.

Like the GitHub API, the Link Header also includes pagination information:

Link: </api/v1/changelogs?perPage=10&page=3>; rel="next", 
  </api/v1/changelogs?perPage=10&page=1>; rel="prev"

The example includes a line break for readability.

The possible rel values are:

Name

Description

next

The link relation for the immediate next page of results.

prev

The link relation for the immediate previous page of results.