Pagination and sorting

Pagination

The Kiteworks API implements a uniform interface for list operations across all top-level resources. Whether retrieving folders, files or users, these methods accept a standard set of query parameters: limit and offset.

By default there is no limit to the number of objects returned in the response body.

Name	Type	Description
limit	integer	Dictates the maximum number of results to return in a single response.
offset	integer	Dictates how many records to skip before starting the list or results in the response body.

Sorting

The Kiteworks API supports sorting through the orderBy parameter, enabling clients to retrieve data in a specified order without client-side sorting.

The orderBy value consists of the field name and sort direction separated by a colon, where asc indicates ascending order and desc indicates descending order. The URL-encoded value for a colon is %3A.

Example

Making a GET request to https://{hostname}/rest/folders/top?orderBy=name%3Aasc returns the list of top folders, ordered by name in ascending order.