Skip to main content
Version: 2025.11

Pageable

Description: A generic paginated response model for handling lists of items.

Attributes

NameTypeDescription
itemsList[T]
totalOptional[Annotated[int, Field(strict=True, ge=0)]]
pageOptional[Annotated[int, Field(strict=True, ge=1)]]
sizeOptional[Annotated[int, Field(strict=True, ge=1)]]
pagesOptional[Annotated[int, Field(strict=True, ge=0)]]

Methods

NameDescription
iter_pagesIterate over all pages using the configured list method.
iter_itemsIterate over all items across all pages.