Skip to main content

Pagination

Overview

REST API list endpoints use page-based pagination.

Pagination defaults and limits:

defaultPage: 1
defaultSize: 10
maxSize: 1000

Request Parameters

NameTypeRequiredDefaultMaxDescription
pagenumberNo1-Page number to return.
sizenumberNo101000Number of records to return per page.

Response Paging

List responses include a paging object with pagination metadata.

{
"paging": {
"size": 20,
"page": 1,
"count": 4,
"limit": 20,
"totalCount": 4,
"totalPages": 1
}
}
FieldTypeDescription
sizenumberRequested page size.
pagenumberCurrent page number.
countnumberNumber of records returned in the current page.
limitnumberApplied page size limit.
totalCountnumberTotal number of records matching the query.
totalPagesnumberTotal number of pages matching the query.

Example

GET /external/v1/withdrawal-intents?page=1&size=20
{
"code": "ok",
"message": "Ok.",
"paging": {
"size": 20,
"page": 1,
"count": 4,
"limit": 20,
"totalCount": 4,
"totalPages": 1
},
"data": []
}

Notes

  • count is the number of records returned in the current page.
  • totalCount is the total number of records matching the query.
  • totalPages is the total number of pages matching the query.
  • limit is the applied page size limit.
  • Pagination fields appear on list responses.