Pagination

To navigate multiple pages, WorkDrive provides two options. They are offset-based pagination and cursor-based pagination.

Offset Pagination

Offset pagination is used to limit the number of items returned in a response of a fixed and predetermined length. Without specifying any pagination parameter, Listing APIs usually return 50 items by default, which is the allowed maximum limit.

If you need to fetch results with user-defined numbers, you must specify the query string parameters as ?page[offset]=0&page[limit]=50, where the offset is the starting value and the limit is the number of items needed in response.

When listing files and folders, if the total count of items is equal to the default limit, it is necessary to make multiple API calls to retrieve all items. If a folder has 200 files, you should call APIs iteratively with pagination parameters as follows:

• page[offset]=0&page[limit]=50
• page[offset]=50&page[limit]=50
• page[offset]=100&page[limit]=50
• page[offset]=150&page[limit]=50

Cursor Pagination

Cursor pagination is used to get a large volume of items in the API response, and you will be able to jump to any particular page. For the initial request, you must specify the query string parameter as ?page[next]=0&page[limit]=1000, where next is the token for a page and the limit is the number of items needed in response. The next page token will be sent in the API response.

links: {
    cursor: {
        has_next: true,
        next: "https://workdrive.zoho.com/workdrive/api/v1/privatespace/ipcpn1aad4e50d6f040be9690501bc5166341/files?page[next]=55019b03582d7"
    }
} 

In the second request, use the URL provided in the next field until has_next becomes false. The has_next indicates whether the next page is available or not. The links object is located below the data object. Listing APIs usually return 1000 items by default if you invoke API call from OAuth token, which is the maximum allowed limit.

In offset pagination, you can jump to any page. For example, from the 6th page, you can jump to the 10th page. But in cursor pagination, you can only go to the next or previous page. Also, if you lose the next page URL, you won't be able to go the next page.

Note: In cursor pagination, listed items won't follow the folder-first approach.