Upply API Pagination
The Upply API uses pagination to help manage large sets of data returned by API requests. Pagination allows clients to retrieve data in smaller, more manageable chunks.
How Pagination Works
Pagination in the Upply API is controlled by two query parameters: limit
and offset
. The limit
parameter specifies the maximum number of records to return in a single response, while the offset
parameter specifies the index of the first record to return.
For example, to retrieve the first 10 records of a data set, you would set the limit
parameter to 10
and the offset
parameter to 0
. To retrieve the next 10 records, you would set the limit
parameter to 10
and the offset
parameter to 10
.
If there are no more records to retrieve, the API will return an empty response.
Pagination Structure
- The listed loads are embedded in a field named
data
- An additional field named
pagination
exists besidedata
- A link to the previous and next pages are provided when they exist in the pafination field.
- All links are objects with
href
field - The pagination must contain the number of elements of the list
limit
fornextPage
andpreviousPage
is always thelimit
of the user’s request or the defaultlimit
offset
ofnextPage
is the actualoffset
+limit
offset
ofpreviousPage
is actualoffset
-limit
Contact Us
If you have any questions or concerns about pagination in the Upply API, please contact us at [email protected].