Some API endpoints are paginated, and will return pagination info in addition to queried data. This pagination info in the response can be used to browse through records in a sorted manner, large queries can be accumulated by clients depending on the users needs.
export type Pagination<T1, T2> = IPagination<T1, T2>;
export interface IPagination<T1, T2> {
data: T1;
pagination: T2;
}
export interface CursorInfo {
cursor: string;
}
The Pagination result types will have the required info to continue the query. Currently all
paginated APIs return a CursorInfo
, with a cursor string that can be passed to the endpoint by a
cursor
query parameter. Future endpoints might add new kinds of pagination info.