Mindbody · Schema

Appointment1

Implementation of the 'Appointment1' model. An appointment

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
GenderPreference	string	Prefered gender of appointment.
Duration	integer	Duration of appointment.
ProviderId	string	If a user has Complementary and Alternative Medicine features enabled, this will allow a Provider ID to be assigned to an appointment.
Id	integer	The unique ID of the appointment.
Status	object	The status of this appointment.
StartDateTime	string	The date and time the appointment will start.
EndDateTime	string	The date and time the appointment will end.
Notes	string	The appointment notes.
PartnerExternalId	string	Optional external key for api partners.
StaffRequested	boolean	Whether the staff member was requested specifically by the client.
ProgramId	integer	The ID of the program this appointment belongs to.
WaitlistEntryId	integer	The ID of the appointment waitlist.
SessionTypeId	integer	The ID of the session type of this appointment.
LocationId	integer	The ID of the location where this appointment will take place.
StaffId	integer	The ID of the staff member instructing this appointment.
ClientId	string	The RSSID of the client booked for this appointment.
FirstAppointment	boolean	Whether this is the client's first appointment at the site.
ClientServiceId	integer	The ID of the pass on the client's account that is paying for this appointment.
Resources	array	The resources this appointment is using.
AddOns	array	The Add-Ons Associated with this appointment
IsWaitlist	boolean	Whether to add appointment to waitlist.
OnlineDescription	string	Online Description associated with the appointment

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-appointment1-schema.json",
  "title": "Appointment1",
  "description": "Implementation of the 'Appointment1' model. An appointment",
  "type": "object",
  "properties": {
    "GenderPreference": {
      "type": "string",
      "description": "Prefered gender of appointment.",
      "example": "example-value"
    },
    "Duration": {
      "type": "integer",
      "format": "int32",
      "description": "Duration of appointment.",
      "example": 1
    },
    "ProviderId": {
      "type": "string",
      "description": "If a user has Complementary and Alternative Medicine features enabled, this will allow a Provider ID to be assigned to an appointment.",
      "example": "example-value"
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The unique ID of the appointment.",
      "example": 123456
    },
    "Status": {
      "$ref": "#/components/schemas/Status1Enum",
      "description": "The status of this appointment."
    },
    "StartDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the appointment will start.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EndDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the appointment will end.",
      "example": "2026-05-28T14:30:00Z"
    },
    "Notes": {
      "type": "string",
      "description": "The appointment notes.",
      "example": "Example note for Mindbody Public API."
    },
    "PartnerExternalId": {
      "type": "string",
      "description": "Optional external key for api partners.",
      "example": "example-value"
    },
    "StaffRequested": {
      "type": "boolean",
      "description": "Whether the staff member was requested specifically by the client.",
      "example": true
    },
    "ProgramId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the program this appointment belongs to.",
      "example": 123456
    },
    "WaitlistEntryId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the appointment waitlist.",
      "example": 123456
    },
    "SessionTypeId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the session type of this appointment.",
      "example": 123456
    },
    "LocationId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the location where this appointment will take place.",
      "example": 123456
    },
    "StaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the staff member instructing this appointment.",
      "example": 123456
    },
    "ClientId": {
      "type": "string",
      "description": "The RSSID of the client booked for this appointment.",
      "example": "example-value"
    },
    "FirstAppointment": {
      "type": "boolean",
      "description": "Whether this is the client's first appointment at the site.",
      "example": true
    },
    "ClientServiceId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the pass on the client's account that is paying for this appointment.",
      "example": 123456
    },
    "Resources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Resource"
      },
      "description": "The resources this appointment is using.",
      "example": [
        {}
      ]
    },
    "AddOns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AddOnSmall1"
      },
      "description": "The Add-Ons Associated with this appointment",
      "example": [
        {}
      ]
    },
    "IsWaitlist": {
      "type": "boolean",
      "description": "Whether to add appointment to waitlist.",
      "example": true
    },
    "OnlineDescription": {
      "type": "string",
      "description": "Online Description associated with the appointment",
      "example": "Example note for Mindbody Public API."
    }
  }
}