IdentifierCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-identifier-collection-schema.json",
  "title": "IdentifierCollection",
  "description": "Collection of identifiers resulting from a bulk add request",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-consent-api-openapi.yml#/components/schemas/IdentifierCollection",
  "required": [
    "limit",
    "offset"
  ],
  "type": "object",
  "properties": {
    "identifiers": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "The list of consent identifiers."
    },
    "count": {
      "type": "integer",
      "description": "The total number of items in the collection.",
      "format": "int32"
    },
    "offset": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "description": "The offset value used for pagination or positioning within a collection.",
      "format": "int32",
      "default": 0
    },
    "limit": {
      "maximum": 10000,
      "minimum": 1,
      "type": "integer",
      "description": "The limit representing the maximum number of items to retrieve or display.",
      "format": "int32",
      "default": 500
    },
    "continuation_token": {
      "type": [
        "string",
        "null"
      ],
      "description": "The continuation token used for pagination to retrieve the next set of results."
    }
  },
  "additionalProperties": false
}