Skip to main content
Section ID: DOC-API-MODEL-schema-ohggnansec#overview

PaginationInfo

Page position and aggregate counts accompanying a paginated provider listing.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-ohggnansec#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-ohggnansec#fields

UsageFields and validation
In responsesView fields

In responses​

Section ID: DOC-API-MODEL-schema-ohggnansec#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-ohggnansec#field-totalSection ID: DOC-API-MODEL-schema-ohggnansec#response-field-totaltotalstring (int64)OptionalTotal number of entries reported by the listing. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-ohggnansec#field-pageSection ID: DOC-API-MODEL-schema-ohggnansec#response-field-pagepagestring (int64)OptionalPage number used by this listing operation. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-ohggnansec#field-perpageSection ID: DOC-API-MODEL-schema-ohggnansec#response-field-perpageperPagestring (int64)OptionalNumber of entries requested per page. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-ohggnansec#field-totalpagesSection ID: DOC-API-MODEL-schema-ohggnansec#response-field-totalpagestotalPagesstring (int64)OptionalTotal number of pages reported for the current query. Pattern: ^-?\d+$.

Where used​

Section ID: DOC-API-MODEL-schema-ohggnansec#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 ID: DOC-API-MODEL-schema-ohggnansec