PagedResultOfEmployeeGroupResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zywave/main/json-schema/zywave-paged-result-of-employee-group-response-schema.json",
  "title": "PagedResultOfEmployeeGroupResponse",
  "description": "A page of results from a larger result set, along with paging metadata.",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/zywave-client-engagement-v3-openapi.json#/components/schemas/PagedResultOfEmployeeGroupResponse",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "items"
  ],
  "properties": {
    "hasMoreResults": {
      "type": "boolean",
      "description": "A value indicating whether the larger result set has more results."
    },
    "skip": {
      "type": "integer",
      "description": "A value indicating how many of the previous values in the larger result set were omitted.",
      "format": "int32",
      "maximum": 2147483647,
      "minimum": 0
    },
    "take": {
      "type": "integer",
      "description": "The number of records retrieved from the larger result set.",
      "format": "int32",
      "maximum": 2147483647,
      "minimum": 0
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of records in the larger result set.",
      "format": "int32",
      "maximum": 2147483647,
      "minimum": 0
    },
    "items": {
      "type": "array",
      "description": "The records retrieved from the larger result set.",
      "items": {
        "$ref": "#/$defs/EmployeeGroupResponse"
      }
    }
  },
  "$defs": {
    "EmployeeGroupResponse": {
      "type": "object",
      "description": "Client-facing employee group response. Exposes only fields accessible to the client — internal audit fields are excluded.",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique identifier of the employee group.",
          "format": "int32"
        },
        "accountId": {
          "type": "integer",
          "description": "The identifier of the account this group belongs to.",
          "format": "int32",
          "maximum": 2147483647,
          "minimum": 1
        },
        "name": {
          "type": "string",
          "description": "The name of the employee group.",
          "maxLength": 100,
          "minLength": 0
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "An optional description for the employee group.",
          "maxLength": 255,
          "minLength": 0
        }
      }
    }
  }
}