Skip to main content

PaginationInfo

Page position and aggregate counts accompanying a paginated provider listing.

Usage profiles​

UsageFields and validation
In responsesView fields

In responses​

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
totalinteger (int32)OptionalTotal number of entries reported by the listing. Minimum: -2147483648. Maximum: 2147483647.
pageinteger (int32)OptionalPage number used by this listing operation. Minimum: -2147483648. Maximum: 2147483647.
perPageinteger (int32)OptionalNumber of entries requested per page. Minimum: -2147483648. Maximum: 2147483647.
totalPagesinteger (int32)OptionalTotal number of pages reported for the current query. Minimum: -2147483648. Maximum: 2147483647.

Where used​

ReferenceRelationship
List webhook event deliveriesPOST /api/v1/webhooks/list-deliveries
List webhook endpointsPOST /api/v1/webhooks/list-endpoints
List webhook subscriptionsPOST /api/v1/webhooks/list-subscriptions

Download the public reference contract.

Document: DOC-API-MODEL-pagination-info.