List endpoints support common pagination and filtering parameters where applicable.
Pagination Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
page | integer | 1 | Must be at least 1. |
limit | integer | 100 | Must be between 1 and 100. Some backend services may cap specific lists lower internally. |
order | string | DESC | Use ASC or DESC. |
sort | string | endpoint-specific | Sort field, when supported. |
query | string | none | Search value, commonly used for references or names. |
startDate | string | none | Filter from a date or datetime. |
endDate | string | none | Filter to a date or datetime. |
currency | string | none | Filter by ISO currency code where supported. |
Paginated Response Shape
Paginated data is returned inside the normal response envelope.
{
"status": true,
"message": "Success",
"code": 200,
"data": {
"data": [],
"meta": {
"page": 1,
"limit": 100,
"total": 0,
"pageCount": 0,
"hasPreviousPage": false,
"hasNextPage": false
}
}
}Reconciliation Tip
For payments and payouts, do not rely only on the current page of results. Store the Kyshi IDs and your own references, then use list filters for reconciliation and recovery.
