Pagination

When a REST API response contains a large number of test cases or test runs, the results are paginated to enhance manageability and performance. By default, you will receive 30 test cases or test runs per page. This document outlines how to navigate through paginated results.

Pagination using page numbers

By default, the first page is listed. To navigate through pages, use the p parameter in the request parameters to load the specific page you want to view.

Note: You can select a page size of either 30 or 300 while using the parameter page_size.

GET /api/v2/projects/{project_id}/test-cases

An example request with query parameter.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects/PR-1/test-case?p=3

How do I know if there are more pages?

The pagination information will be included at the end of the API response under info. If the next parameter is set to null, you are on the last page of the results.

Response Attributes

Response

"info": {
    "page": 3,
    "page_size": 30,
    "count": 82,
    "prev": 2,
    "next": null
  }