Skip to main content

PaginatedResponse

Generic paginated response

pageinteger

The current pagination page

perPageinteger

The requested number of entries per page

lastPageinteger

The last page with entries

totalinteger

The total number of entries

firstPageUrlstring

URL for the first page

lastPageUrlstring

URL for the last page

nextPageUrlstringnullable

URL for the next page

previousPageUrlstringnullable

URL for the previous page

nextPageintegernullable

The page number for the next page. Null if no next page.

previousPageintegernullable

The page number for the previous page. Null if no previous page.

frominteger

The entry offset for the first entry in the page

tointeger

The entry offset for the last entry in the page

pathstring

The path for the pagination endpoint

itemsundefined[]

The page contents

PaginatedResponse
{
"page": 0,
"perPage": 0,
"lastPage": 0,
"total": 0,
"firstPageUrl": "string",
"lastPageUrl": "string",
"nextPageUrl": "string",
"previousPageUrl": "string",
"nextPage": 0,
"previousPage": 0,
"from": 0,
"to": 0,
"path": "string",
"items": [
null
]
}