Pagination
VBAPI supports pagination to help manage large result sets efficiently. You can control the number of records returned and the page being requested.
Request Parameters
Include the following in your SearchRequest
:
-
page
: Zero-based index of the page (e.g.,0
= first page). -
pageCount
: Number of records to return per page.
Example
Response Header The API response includes an X-Pagination header containing metadata about the result set:
X-Pagination:
{
"TotalCount": 1000,
"TotalPages": 10,
"CurrentPage": 0,
"PageSize": 100
}
This makes it easy to build UI pagination controls and manage navigation across large datasets.