Skip to content

Pagination

Type: schema

Description

pagination metadata structure

TypeScript Definition

typescript
Pagination: {{
            total_records?: number;
            total_pages?: number;
            previous_page?: ((number | null) | null) | null;
            /** @default 25 */
            limit: number;
            next_page?: ((number | null) | null) | null;
        };
        /** PartialCollectAndDelivery */
}

OpenAPI Schema

json
{
  "description": "pagination metadata structure",
  "type": "object",
  "properties": {
    "total_records": {
      "type": "integer"
    },
    "total_pages": {
      "type": "integer"
    },
    "previous_page": {
      "type": [
        "integer",
        "null"
      ],
      "nullable": true
    },
    "limit": {
      "type": "integer",
      "default": 25
    },
    "next_page": {
      "type": [
        "integer",
        "null"
      ],
      "nullable": true
    }
  },
  "title": "Pagination"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: