Mindbody · JSON Structure

Public Api V6 Get Client Formula Notes Response Structure

Implementation of the 'GetClientFormulaNotesResponse' model. Enables to retrieve cross regional formula notes for a client, or for a specific appointment. The two parameters are optional, however at least one must be provided. This endpoint supports pagination.

Type: object Properties: 2
FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

GetClientFormulaNotesResponse is a JSON Structure definition published by Mindbody, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

PaginationResponse FormulaNotes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-get-client-formula-notes-response-structure.json",
  "name": "GetClientFormulaNotesResponse",
  "description": "Implementation of the 'GetClientFormulaNotesResponse' model. Enables to retrieve cross regional formula notes for a client, or for a specific appointment. The two parameters are optional, however at least one must be provided. This endpoint supports pagination.",
  "type": "object",
  "properties": {
    "PaginationResponse": {
      "$ref": "#/components/schemas/PaginationResponse",
      "description": "Contains information about the pagination used."
    },
    "FormulaNotes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FormulaNoteResponse"
      },
      "description": "Contains details about the client\u2019s formula.",
      "example": [
        {}
      ]
    }
  }
}