YQueue DocsDevelopers

Schema

Page Pagination Meta

Metadata for responses that use page-based pagination.

  • Foundation

Overview

object · 6 properties · 6 required

Properties

current_page

integer Required

The current page number.

Minimum 1

last_page

integer Required

The last available page of results.

Minimum 1

first_item_on_current_page

integer | null Required

The position of the first result on this page, or `null` when there are no results.

Minimum 1
Nullable Yes

last_item_on_current_page

integer | null Required

The position of the last result on this page, or `null` when there are no results.

Minimum 1
Nullable Yes

per_page

integer Required

The maximum number of results returned per page.

Minimum 1

total_results

integer Required

The total number of results across all pages.

Minimum 0

Used by

Raw YAML
Download source
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.

Search documentation

Search across this documentation site.