Pagination

In Identity360, you can retrieve multiple resources using listing APIs, such as list users, list groups, and list departments. The process of fetching these resources in chunks for better performance is called pagination. Pagination is a technique used to divide a large set of data into smaller, more manageable chunks or pages. This is particularly useful when dealing with APIs that return a large number of records, as it allows clients to retrieve only a subset of the data at a time, reducing the amount of data transferred and improving performance.

Offset Pagination

Offset pagination is a simple and commonly used technique where the client retrieves a subset of data by specifying the starting index (from) and the number of records to return (limit). This method is best suited for relatively static datasets where the data doesn’t change frequently during pagination.

When using offset pagination, the client specifies two parameters in the API request:

Parameter	Description
from	The index of the starting object.
limit	The number of individual objects that are returned in each request.


https://id360.manageengine.com/api/v1/users?from=0&limit=10


{
    "data": [],
    "meta": {
        "start_index": "1",
        "limit": 200,
        "total_no_of_objects": 7
    }
}

Cursor Pagination

Cursor pagination is a robust and efficient technique for paginating large or frequently changing datasets. Instead of skipping records by index, it uses a cursor to mark the position in the dataset. This approach ensures consistent pagination even when records are added or removed during traversal.

When using Cursor pagination, the client specifies two parameters in the API request:

Parameter	Description
cursor	The cursor for the next set of records; this can be obtained from the previous response.
limit	The number of individual objects that are returned in each request; t he maximum limit for each request is 200.


https://id360.manageengine.com/api/v1/users?limit=100&cursor=eyJJRCI6Nzc3MDAwMDAxMjIzNzI0fQ==


{
    "data": [],
    "meta": {
        "cursor": "eyJJRCI6Nzc3MDAwMDAxMjIzNzI0fQ==",
        "next_cursor": "eyJJRCI6Nzc3MDAwMDAxMjIzNjU4fQ==",
        "is_last": false,
        "limit": 100,
        "total": 254
    }
}