ConsentCategoryCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-consent-category-collection-schema.json",
  "title": "ConsentCategoryCollection",
  "description": "A collection of consent categories.",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-communication-preference-api-openapi.yml#/components/schemas/ConsentCategoryCollection",
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "The number of consent categories in the list.",
      "format": "int32",
      "readOnly": true
    },
    "value": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/ConsentCategory"
      },
      "description": "The set of consent categories included in the response."
    }
  },
  "additionalProperties": false,
  "$defs": {
    "ConsentCategory": {
      "type": "object",
      "properties": {
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the consent category."
        },
        "inactive": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Indicates whether the consent category is inactive."
        },
        "sequence": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The placement of the category in the order of category table values, if defined.",
          "format": "int32"
        }
      },
      "additionalProperties": false,
      "description": "Represents the consent category entity."
    }
  }
}