Pagination And Filtering

List endpoints support common pagination and filtering parameters where applicable.

Pagination Parameters

ParameterTypeDefaultNotes
pageinteger1Must be at least 1.
limitinteger100Must be between 1 and 100. Some backend services may cap specific lists lower internally.
orderstringDESCUse ASC or DESC.
sortstringendpoint-specificSort field, when supported.
querystringnoneSearch value, commonly used for references or names.
startDatestringnoneFilter from a date or datetime.
endDatestringnoneFilter to a date or datetime.
currencystringnoneFilter 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.