Skip to main content
Version: 2.5

ListPage

A single page of items returned from a list() method.

Index

Constructors

__init__

  • __init__(data): None
  • Initialize a ListPage instance from the API response data.


    Parameters

    • data: dict

    Returns None

Properties

count

count: int

Count of the returned objects on this page

desc

desc: bool

Whether the listing is descending or not

items

items: list[T]

List of returned objects on this page

limit

limit: int

The offset of the first object specified in the API call

offset

offset: int

The limit on the number of returned objects offset specified in the API call

total

total: int

Total number of objects matching the API call criteria