Readonly
countActual number of results returned.
Readonly
limitNumber of results requested.
Optional
Readonly
metaObject containing supplementary information about the results.
Readonly
offsetNumber of elements skipped.
Readonly
resultsThe resources matching the query predicate. Each query endpoint returns resources of its specific type.
Optional
Readonly
totalTotal number of results matching the query.
This number is an estimation that is not strongly consistent.
This field is returned by default.
For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false
.
When the results are filtered with a Query Predicate, total
is subject to a limit.
Each query endpoint returns a paged query response containing the actual resources matching the query predicate plus information about pagination. This documents the fields all query responses have in common, for specific response types, see the respective API reference pages.