PeopleResponseDto

Endpoints · All schemas

People response

Field	Required	Description
hasNextPage	No	Whether there are more pages
hidden	Yes	Number of hidden people
people	Yes	array
total	Yes	Total number of people

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: PeopleListItemDto

{
  "description": "People response",
  "properties": {
    "hasNextPage": {
      "description": "Whether there are more pages",
      "type": "boolean"
    },
    "hidden": {
      "description": "Number of hidden people",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "people": {
      "items": {
        "$ref": "#/components/schemas/PeopleListItemDto"
      },
      "type": "array"
    },
    "total": {
      "description": "Total number of people",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "hidden",
    "people",
    "total"
  ],
  "type": "object"
}