Olyn API Pagination

Learn how to handle pagination at Olyn API

Introduction

All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list assets, data_modules and file_modules. These list API methods share a common structure, taking at least these two parameters: page, and pageSize.

Olyn's list API methods utilize offset-limit pagination via the page and pageSize parameters. pageSize parameter defines the number of results per request, while page returns the relative results from the total amount of resources taking into account the pageSize restriction.


Parameters

page optional, default is 1
page retrieved from the subset of the whole matching resources from the request starts at 1 and does not have an upper limit.

pageSize optional, default is 250
pageSize determines the number of resources to return from the request.


List Response Format

data list
A list containing the total amount of objects from the requested resource.

page integer
A number indicating the page requested

pageSize integer
A number indicating the total amount of objects requested.

totalCount integer
A number indicating the total amount of objects from a given resource matching the request.

count integer
A number indicating the total amount of objects in the request.


Get API Keys

Learn about the different resources you can interact with Olyn API

Did this page help you?