Skip to main content

Pagination metadata for list responses

count
integer
required

Total number of items matching the query

Required range: x >= 0
Example:

100

pages
integer
required

Total number of pages

Required range: x >= 0
Example:

4

page
integer
required

Current page number (1-indexed)

Required range: x >= 1
Example:

1

page_size
integer
required

Number of items per page

Required range: x >= 1
Example:

25

has_next
boolean
required

Whether there is a next page

Example:

true

has_previous
boolean
required

Whether there is a previous page

Example:

false