This section provides important information about the common pagination mechanism adopted by Fabrick Platform APIs.
Pagination is available for an endpoint whenever the PAGINATION option is highlighted in the technical documentation.
Request
If available, the request for pagination is managed through query parameters:
<HTTP VERB> <URI>?offset={offset}&limit={limit}&pagination={pagination}
The offset parameter is the 0-based positional index of the first element to be provided in the response. A positive integer is expected; default value is 0.Additional information:
- If
offset >= resultCountthe response is always empty (fetching over last available result). - If
offset < 0an HTTP-400 Bad Request error is returned (a positive integer is expected).
The
limit parameter is the number of elements to be provided in the response. A positive integer is expected; default value is 20.Additional information:
- If
limit < 0an HTTP-400 Bad Request error is returned (a positive integer is expected).
The
pagination parameter is a boolean flag used to request the pagination element in the response. Default value is true.Response
If pagination is requested, the response body will include the pagination element:
{
...
"pagination": {
"pageCount": 50,
"resultCount": 495,
"offset": 0,
"limit": 10
}
}
The
pageCount field contains the total number of pages, assuming each page contains limit number of elements.The
resultCount field contains the total number of result elements.The
offset field contains the positional index of the first element provided in the response.The
limit field contains the maximum number of elements to be expected in the response.