Mindbody · Schema

Staff1

Implementation of the 'Staff1' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
Id	integer	The ID assigned to the staff member.
FirstName	string	The staff member’s first name.
LastName	string	The staff member’s last name.
DisplayName	string	The display name of the staff member.
Email	string	The staff member’s email address.
Bio	string	The staff member’s biography. This string contains HTML.
Address	string	The address of the staff member who is teaching the class.
Address2	string	The address2 of the staff member who is teaching the class.
City	string	The staff member’s city.
State	string	The staff member’s state.
PostalCode	string	The staff member’s postal code.
ForeignZip	string	The staff member’s Foreign Zip code.
Country	string	The staff member’s country.
WorkPhone	string	The staff member’s work phone number.
HomePhone	string	The staff member’s home phone number.
CellPhone	string	The staff member’s mobile phone number.
Active	boolean	When `true`, indicates that the staff member is Active. When `false`, indicates that the staff member is not Active.
IsSystem	boolean	When `true`, indicates that the staff member is a system . When `false`, indicates that the staff member is not system.
SmodeId	integer	The Staff's Smode Id
AppointmentTrn	boolean	When `true`, indicates that the staff member offers appointments. When `false`, indicates that the staff member does not offer appointments.
AlwaysAllowDoubleBooking	boolean	When `true`, indicates that the staff member can be scheduled for overlapping services. When `false`, indicates that the staff can only be scheduled for one service at a time in any given time-frame.
IndependentContractor	boolean	When `true`, indicates that the staff member is an independent contractor. When `false`, indicates that the staff member is not an independent contractor.
ImageUrl	string	The URL of the staff member’s image, if one has been uploaded.
IsMale	boolean	When `true`, indicates that the staff member is male. When `false`, indicates that the staff member is female.
ReservationTrn	boolean	When `true`, indicates that the staff member offers Reservation. When `false`, indicates that the staff member does not offer Reservation.
SortOrder	integer	If configured by the business owner, this field determines a staff member’s weight when sorting. Use this field to sort staff members on your interface.
MultiLocationPermission	boolean	When `true`, indicates that the staff member has Multi Location Permission. When `false`, indicates that the staff member does not has Multi Location Permission.
Name	string	The staff member’s name.
ProviderIDs	array	A list of ProviderIds for the staff.
StaffSettings	object	This object contains the staff settings.
Rep	boolean	When `true`, indicates that the staff is sales Rep 1 else `false`.
Rep2	boolean	When `true`, indicates that the staff is sales Rep 2 else `false`.
Rep3	boolean	When `true`, indicates that the staff is sales Rep 3 else `false`.
Rep4	boolean	When `true`, indicates that the staff is sales Rep 4 else `false`.
Rep5	boolean	When `true`, indicates that the staff is sales Rep 5 else `false`.
Rep6	boolean	When `true`, indicates that the staff is sales Rep 6 else `false`.
Assistant	boolean	When `true`, indicates that the staff is assistant. When `false`, indicates that the staff is not assistant.
Assistant2	boolean	When `true`, indicates that the staff is assistant2. When `false`, indicates that the staff is not assistant2.
EmploymentStart	string	The start date of employment.
EmploymentEnd	string	The end date of employment.
EmpID	string	The custom staff ID assigned to the staff member.
Appointments	array	A list of appointments for the staff.
Unavailabilities	array	A list of unavailabilities for the staff.
Availabilities	array	A list of availabilities for the staff.
LoginLocations	array	A list of LoginLocations for the staff

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-staff1-schema.json",
  "title": "Staff1",
  "description": "Implementation of the 'Staff1' model.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The ID assigned to the staff member.",
      "example": 123456
    },
    "FirstName": {
      "type": "string",
      "description": "The staff member\u2019s first name.",
      "example": "Alex"
    },
    "LastName": {
      "type": "string",
      "description": "The staff member\u2019s last name.",
      "example": "Lane"
    },
    "DisplayName": {
      "type": "string",
      "description": "The display name of the staff member.",
      "example": "example-value"
    },
    "Email": {
      "type": "string",
      "description": "The staff member\u2019s email address.",
      "example": "[email protected]"
    },
    "Bio": {
      "type": "string",
      "description": "The staff member\u2019s biography. This string contains HTML.",
      "example": "example-value"
    },
    "Address": {
      "type": "string",
      "description": "The address of the staff member who is teaching the class.",
      "example": "123 Market St"
    },
    "Address2": {
      "type": "string",
      "description": "The address2 of the staff member who is teaching the class.",
      "example": "123 Market St"
    },
    "City": {
      "type": "string",
      "description": "The staff member\u2019s city.",
      "example": "San Francisco"
    },
    "State": {
      "type": "string",
      "description": "The staff member\u2019s state.",
      "example": "CA"
    },
    "PostalCode": {
      "type": "string",
      "description": "The staff member\u2019s postal code.",
      "example": "94110"
    },
    "ForeignZip": {
      "type": "string",
      "description": "The staff member\u2019s Foreign Zip code.",
      "example": "example-value"
    },
    "Country": {
      "type": "string",
      "description": "The staff member\u2019s country.",
      "example": "US"
    },
    "WorkPhone": {
      "type": "string",
      "description": "The staff member\u2019s work phone number.",
      "example": "+15551234567"
    },
    "HomePhone": {
      "type": "string",
      "description": "The staff member\u2019s home phone number.",
      "example": "+15551234567"
    },
    "CellPhone": {
      "type": "string",
      "description": "The staff member\u2019s mobile phone number.",
      "example": "+15551234567"
    },
    "Active": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member is Active. When `false`, indicates that the staff member is not Active.",
      "example": true
    },
    "IsSystem": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member is a system . When `false`, indicates that the staff member is not system.",
      "example": true
    },
    "SmodeId": {
      "type": "integer",
      "format": "int32",
      "description": "The Staff's Smode Id",
      "example": 123456
    },
    "AppointmentTrn": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member offers appointments. When `false`, indicates that the staff member does not offer appointments.",
      "example": true
    },
    "AlwaysAllowDoubleBooking": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member can be scheduled for overlapping services. When `false`, indicates that the staff can only be scheduled for one service at a time in any given time-frame.",
      "example": true
    },
    "IndependentContractor": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member is an independent contractor. When `false`, indicates that the staff member is not an independent contractor.",
      "example": true
    },
    "ImageUrl": {
      "type": "string",
      "description": "The URL of the staff member\u2019s image, if one has been uploaded.",
      "example": "https://example.mindbodyonline.com/resource/abc123"
    },
    "IsMale": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member is male. When `false`, indicates that the staff member is female.",
      "example": true
    },
    "ReservationTrn": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member offers Reservation. When `false`, indicates that the staff member does not offer Reservation.",
      "example": true
    },
    "SortOrder": {
      "type": "integer",
      "format": "int32",
      "description": "If configured by the business owner, this field determines a staff member\u2019s weight when sorting. Use this field to sort staff members on your interface.",
      "example": 1
    },
    "MultiLocationPermission": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff member has Multi Location Permission. When `false`, indicates that the staff member does not has Multi Location Permission.",
      "example": true
    },
    "Name": {
      "type": "string",
      "description": "The staff member\u2019s name.",
      "example": "Sunset Yoga Studio"
    },
    "ProviderIDs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of ProviderIds for the staff.",
      "example": [
        "example-value"
      ]
    },
    "StaffSettings": {
      "$ref": "#/components/schemas/StaffSetting",
      "description": "This object contains the staff settings."
    },
    "Rep": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is sales Rep 1 else `false`.",
      "example": true
    },
    "Rep2": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is sales Rep 2 else `false`.",
      "example": true
    },
    "Rep3": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is sales Rep 3 else `false`.",
      "example": true
    },
    "Rep4": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is sales Rep 4 else `false`.",
      "example": true
    },
    "Rep5": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is sales Rep 5 else `false`.",
      "example": true
    },
    "Rep6": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is sales Rep 6 else `false`.",
      "example": true
    },
    "Assistant": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is assistant. When `false`, indicates that the staff is not assistant.",
      "example": true
    },
    "Assistant2": {
      "type": "boolean",
      "description": "When `true`, indicates that the staff is assistant2. When `false`, indicates that the staff is not assistant2.",
      "example": true
    },
    "EmploymentStart": {
      "type": "string",
      "format": "date-time",
      "description": "The start date of employment.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EmploymentEnd": {
      "type": "string",
      "format": "date-time",
      "description": "The end date of employment.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EmpID": {
      "type": "string",
      "description": "The custom staff ID assigned to the staff member.",
      "example": "example-value"
    },
    "Appointments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Appointment1"
      },
      "description": "A list of appointments for the staff.",
      "example": [
        {}
      ]
    },
    "Unavailabilities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Unavailability1"
      },
      "description": "A list of unavailabilities for the staff.",
      "example": [
        {}
      ]
    },
    "Availabilities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Availability1"
      },
      "description": "A list of availabilities for the staff.",
      "example": [
        {}
      ]
    },
    "LoginLocations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Location1"
      },
      "description": "A list of LoginLocations for the staff",
      "example": [
        {}
      ]
    }
  }
}