Request

All pagination APIs accept the following arguments:

page integer, optional

The page to request, with 1 being the first page. Defaults to 1.

rowsPerPage integer, optional

The number of rows to return per page. Defaults to 100.

Responses

All pagination APIs response with the following convention (results may appear inside a different parent context):

{
  "page": 1,
  "minPage": 1,
  "maxPage": 1,
  "numRows": 5,
  "rows": []
}

page integer

The page number. This is not necessarily what was requested: if the requested page was out of range, or no page number was specified.

minPage integer

The lowest allowable page number. Always 1.

maxPage integer

The highest allowable page number, depending on the rowsPerPage.