Pagination

All list APIs return paginated results, allowing clients to request only what they need. This can save bandwidth and reduce request times. List APIs use a page-based pagination pattern.

All list APIs include the following properties in the response:

Property

Type

Description

page

Number

The current page, indexed starting from 1. Defaults to 1.

pageSize

Number

The maximum number of items per page. Defaults to 100.

total

Number

The total number of items.

totalPages

Number

The total number of pages, computed from total and pageSize.

hasNext

Boolean

Specifies whether a next page exists.

items

Object []

The array of result objects.

List APIs are designed to provide an efficient overview of resources, so certain properties may appear only in the detail response fetched using the resource ID. View the API spec to learn more.