Mindbody · Schema

ClientIndex

Implementation of the 'ClientIndex' model. A client index.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
Id	integer	The unique ID of the client index.
Name	string	The name of the client index.
RequiredBusinessMode	boolean	When `true`, indicates that the index is required when creating profiles in business mode.
RequiredConsumerMode	boolean	When `true`, indicates that the index is required when creating profiles in consumer mode.
Values	array	Contains a list with a single object representing the index value assigned to the client index.
Action	object	The action performed on this object.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-client-index-schema.json",
  "title": "ClientIndex",
  "description": "Implementation of the 'ClientIndex' model. A client index.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The unique ID of the client index.",
      "example": 123456
    },
    "Name": {
      "type": "string",
      "description": "The name of the client index.",
      "example": "Sunset Yoga Studio"
    },
    "RequiredBusinessMode": {
      "type": "boolean",
      "description": "When `true`, indicates that the index is required when creating profiles in business mode.",
      "example": true
    },
    "RequiredConsumerMode": {
      "type": "boolean",
      "description": "When `true`, indicates that the index is required when creating profiles in consumer mode.",
      "example": true
    },
    "Values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ClientIndexValue"
      },
      "description": "Contains a list with a single object representing the index value assigned to the client index.",
      "example": [
        {}
      ]
    },
    "Action": {
      "$ref": "#/components/schemas/Action8Enum",
      "description": "The action performed on this object."
    }
  }
}