BigCommerce · Schema

pagination_Full

Data about the response, including pagination and collection totals.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

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

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pagination_Full",
  "title": "pagination_Full",
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "description": "Total number of items in the result set.\n",
      "example": 36
    },
    "count": {
      "type": "integer",
      "description": "Total number of items in the collection response.\n",
      "example": 36
    },
    "per_page": {
      "type": "integer",
      "description": "The amount of items returned in the collection per page, controlled by the limit parameter.\n",
      "example": 50
    },
    "current_page": {
      "type": "integer",
      "description": "The page you are currently on within the collection.\n",
      "example": 1
    },
    "total_pages": {
      "type": "integer",
      "description": "The total number of pages in the collection.\n",
      "example": 1
    },
    "links": {
      "type": "object",
      "properties": {
        "previous": {
          "type": "string",
          "description": "Link to the previous page returned in the response.\n"
        },
        "current": {
          "type": "string",
          "description": "Link to the current page returned in the response.\n",
          "example": "?page=1&limit=50"
        },
        "next": {
          "type": "string",
          "description": "Link to the next page returned in the response.\n"
        }
      },
      "description": "Pagination links for the previous and next parts of the whole collection.\n"
    }
  },
  "description": "Data about the response, including pagination and collection totals.",
  "x-internal": false
}