Home > @vsf-enterprise/bigcommerce-api > Pagination

# Pagination interface

Pagination model including all necessary information for pagination.

Signature:

export interface Pagination 

# Properties

Property Type Description
count? number (Optional) Total number of items in the collection response.
current_page? number (Optional) The page you are currently on within the collection.
links? PaginationLinks (Optional) Pagination links for the previous and next parts of the whole collection.
per_page? number (Optional) The amount of items returned in the collection per page, controlled by the limit parameter.
total_pages? number (Optional) The total number of pages in the collection.
total? number (Optional) Total number of items in the result set.