title: Page Pagination Meta
x-tags:
  - Foundation
type: object
description: Metadata for responses that use page-based pagination.
required:
  - current_page
  - last_page
  - first_item_on_current_page
  - last_item_on_current_page
  - per_page
  - total_results
properties:
  current_page:
    type: integer
    minimum: 1
    description: The current page number.
  last_page:
    type: integer
    minimum: 1
    description: The last available page of results.
  first_item_on_current_page:
    type:
      - integer
      - 'null'
    minimum: 1
    description: The position of the first result on this page, or `null` when there are no results.
  last_item_on_current_page:
    type:
      - integer
      - 'null'
    minimum: 1
    description: The position of the last result on this page, or `null` when there are no results.
  per_page:
    type: integer
    minimum: 1
    description: The maximum number of results returned per page.
  total_results:
    type: integer
    minimum: 0
    description: The total number of results across all pages.
