pagination

The one shape every paginated listing echoes.

Concrete listing responses inherit this base instead of redeclaring total/offset/limit — the fields, their names and their meanings then cannot drift between endpoints.

PaginatedResponse pydantic-model

Bases: BaseModel

Base fields for a paginated listing response.

Fields:

• total (NonNegativeInt)
• offset (NonNegativeInt)
• limit (PositiveInt)

limit pydantic-field

Maximum items in this page.

offset pydantic-field

Offset this page was read at.

total pydantic-field

Total items matching the query, across all pages.