Properties
| Name | Type | Description |
|---|---|---|
| results | array | |
| start | integer | |
| limit | integer | |
| size | integer | |
| totalSize | integer | This property will return total count of the objects before pagination is applied. This value is returned if `shouldReturnTotalSize` is set to `true`. |
| _links | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UserArray",
"title": "UserArray",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
},
"example": []
},
"start": {
"type": "integer",
"format": "int32",
"example": 10
},
"limit": {
"type": "integer",
"format": "int32",
"example": 10
},
"size": {
"type": "integer",
"format": "int32",
"example": 10
},
"totalSize": {
"type": "integer",
"format": "int64",
"default": 0,
"description": "This property will return total count of the objects before pagination is applied.\nThis value is returned if `shouldReturnTotalSize` is set to `true`.",
"example": 10
},
"_links": {
"$ref": "#/components/schemas/GenericLinks"
}
}
}