--- title: "The way to find all staff or a single staff member." method: GET path: "/Users/Staff" tags: ["Rest"] --- # The way to find all staff or a single staff member. `GET /Users/Staff` ## Query parameters - `request.staffIds` integer[] - `request.staffCredentials.username` string - `request.staffCredentials.password` string - `request.staffCredentials.siteIds` integer[] - `request.filters` string[] - `request.sessionTypeId` integer - `request.startDateTime` string, date-time - `request.locationId` integer ## Headers - `SiteId` integer, required ## Response `200` OK - MindbodyRestApiDtoModelsSiteStaff[] - `Nickname` string — Nickname for the staff member. Maps to TrDear in DB. - `Address` string — Address of the staff member. - `Address2` string — Second line of the address of the staff member. - `City` string — The city the staff is in. - `State` string — The state the staff is in. - `PostalCode` string — The postal code for the staff. - `ForeignZip` string — Foreign postal code for staff - `Country` string — The country the staff is in. - `WorkPhone` string — The work phone number for the staff. - `WorkExt` string — The work extension number for the staff's work phone number. - `HomePhone` string — The home phone number for the staff member. - `CellPhone` string — The cell phone number of the staff. - `PhoneNumber` string — Computed between the three available - `Pager` string — The pager number of the staff if applicable. - `FaxNumber` string — The fax number of the staff. - `Birthdate` string, date-time — The birthdate of the staff. - `Notes` string — The notes for the staff. - `Teacher` boolean — If the staff is a teacher or not. - `MassageTherapist` boolean — If the staff is a massage therapist. - `WorkshopInstructor` boolean — If the staff is a workshop instructor. - `Employee` boolean — If the staff is an employee. - `Active` boolean — If the staff is active. - `Deleted` boolean — If the staff is deleted. - `Locked` boolean — If the staff is locked. - `Location` integer — The studio location of the staff if there are more than 1 studio location possibilities. - `Closed` boolean — If the staff is closed. - `Assistant` boolean — If the staff can be an assistant. - `Ssn` string — The social security number of the staff. - `Assistant2` boolean — If the staff can be an assistant2. - `EmpID` string — The employee ID of the staff. - `CanBeAssignedFollowups` boolean — If the staff can be assigned followups. Maps to CRM in the DB. - `HourlyRate` number, double — The hourly rate of the staff. - `StdStaffCommissionPercRate` number, float — The standard staff commission percent rate. - `StdStaffCommissionFlatRate` number, double — The standard staff commission flat rate. - `PromoStaffCommissionPercRate` number, float — The promo staff commission flat rate. - `PromoStaffCommissionFlatRate` number, double — The promo staff commission flat rate. - `EarnsCommissions` boolean — If the staff earns commissions. - `AppointmentStaff` boolean — If the staff is an appointment trainer. - `ReservationStaff` boolean — If the staff is a reservation trainer. - `DefaultDeptID` string — The default department ID of the staff. - `Rep1` boolean — If the staff is a rep1 for clients. - `Rep2` boolean — If the staff is a rep2 for clients. - `Rep3` boolean — If the staff is a rep3 for clients. - `Rep4` boolean — If the staff is a rep4 for clients. - `Rep5` boolean — If the staff is a rep5 for clients. - `Rep6` boolean — If the staff is a rep6 for clients. - `EarnsTips` boolean — If the staff earns tips. - `HideInPayrollExport` boolean — If the staff is hidden in payroll exports. - `DisableAttachments` boolean — If the staff has attachments disabled. - `EmploymentEnd` string, date-time — The staff's Employment end date. - `EmploymentStart` string, date-time — The staff's Employment start date. - `IndependentContractor` boolean — If the staff is an independent contractor. - `GoogleCalUserName` string — The google calendar user name for the staff. - `GoogleCalID` string — The google calendar ID for the staff. - `MobileProvider` integer — The Mobile provider enum for the staff. - `AutomatedContactMethod` integer — The automated contact method for the staff. - `IsSystem` boolean — If the staff is a system staff. - `LastGoogleSyncStart` string, date-time — The date of the last google sync start. - `LastGoogleSyncEnd` string, date-time — The date of the last google sync end. - `AlwaysAllowDoubleBooking` boolean — If double booking is always allowed. - `NameForDropDown` string — Name of the staff member. - `ImageURL` string — The staff member's profile image URL. It will not be returned if it does not exist. - `IsSalesRep` boolean — Whether or not this staff member can be a client rep. - `IsOwner` boolean — If the staff is a HIPAA-fied owner. - `MindbodyEmailOptIn` boolean — Whether the staff is opted in for Mindbody emails. - `CreationDateTime` string, date-time — Creation date of the staff member. - `UserAccessLevel` string — User access level for the staff. Note: This is only available when providing staff credentials. - `IsServiceProvider` boolean — Flag set for staff that have had services booked within last 30 days. - `LoginLocations` MindbodyRestApiDtoModelsSiteLoginLocation[] — Login locations for the staff member. - `Id` integer — Location unique identifier. - `Address` string — Location address - `Address2` string — Second line of the location address - `BusinessDescription` string — Location's business description - `City` string — City of location - `Description` string — Location's description - `FacilitySquareFeet` integer — Location's total square footage - `HasClasses` boolean — If the location has classes scheduled - `Latitude` number, double — Location's latitude value - `Longitude` number, double — Location's longitude value - `Name` string — Name of the location - `Phone` string — Location's phone number - `PhoneExtension` string — Location's phone extension, if any - `PostalCode` string — Location's postal code - `SiteId` integer — Location's subscriber id, if any - `StateProvCode` string — Location's state code - `Tax1` number, float — Location's tax 1 value - `Tax2` number, float — Location's tax 2 value - `Tax3` number, float — Location's tax 3 value - `Tax4` number, float — Location's tax 4 value - `Tax5` number, float — Location's tax 5 value - `TreatmentRooms` integer — Number of treatment rooms at the location, if available - `MasterLocationId` integer — Unique identifier for the master location, if any - `Gender` boolean — Gender of the staff member. Male if true, female if false. - `Bio` string — The staff member's biography information. - `ProviderIDs` MindbodyRestApiDtoModelsSiteStaffProvider[] — Providers for the staff member. - `ID` integer — Unique identifier - `StaffID` integer — Staff associated with the provider - `ProviderID` string — Provider associated with the staff - `Active` boolean — Whether this is an active mapping or not. - `ID` integer — Unique identifier for the staff member. - `UserGuid` string, uuid — GUID for the staff member. - `PermissionGroupName` string — Permission group name for the staff member. Usually maps to 'status' in DB. - `SModeID` integer — The user unique identifier for the staff member. - `DisplayName` string — The display name for the staff member. - `SortOrder` integer — Integer that represents the sort order for the staff member. - `EmailAddress` string — Staff member's email address. - `FirstName` string — Staff member's first name. - `LastName` string — Staff member's last name. - `Name` string — The Full Name of this staff, a calculated field that returns the FirstName + " " + LastName - `UserName` string — The username of this staff - `HomeSiteID` integer — The homesite ID of this staff - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] — Appointments for the staff member. - `Client` MindbodyRestApiCommonModelsSiteClientsClientMedium - `ExternalID` string - `OptedIn` boolean - `OptedInForPromotions` boolean - `WorkPhone` string - `WorkExtension` string - `HomePhone` string - `MobilePhone` string - `Email` string - `YellowAlert` string - `RedAlert` string - `GenderPreference` 'None' | 'Male' | 'Female' - `IsSystem` boolean - `FirstApptDate` string, date-time - `Inactive` boolean - `CommunicationPreferences` MindbodyRestApiCommonModelsSiteClientsClientNotificationPreferences - `ClientId` integer - `StudioId` integer - `PromotionalEmailOptIn` boolean - `PromotionalTextOptIn` boolean - `ScheduleEmailOptIn` boolean - `ScheduleTextOptIn` boolean - `AccountEmailOptIn` boolean - `AccountTextOptIn` boolean - `OperationalEmailOptIn` boolean - `TwilioOptIn` boolean - `LegacyPreferences` MindbodyRestApiCommonModelsSiteClientsLegacyClientNotificationPreferences - `OptedIn` boolean - `OptedInForPromotions` boolean - `AutomatedContactMethod` 'NormalOnly' | 'MobileOnly' | 'MobileAndNormal' - `OptOutSMSSentDateUTC` string, date-time - `Name` string - `NameFormattedForAppointmentSchedule` string - `IsCompany` boolean - `FormulaNotes` MindbodyRestApiCommonModelsSiteFormulaNote[] - `ID` integer - `ClientID` integer - `Note` string - `EntryDateTime` string, date-time - `CreatedByID` integer - `AppointmentID` integer - `CreatedBy` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `ClientMembership` MindbodyRestApiCommonModelsSiteClientMembership - `ID` integer - `ClientID` integer - `ActiveDate` string, date-time - `ExpDate` string, date-time - `SeriesTypeName` string - `TypePurch` string - `SeriesTypeID` integer - `IconNum` integer - `SeriesType` MindbodyRestApiCommonModelsSiteMembershipSeriesType - `SortOrder` integer - `MembersOnlyServiceDiscount` number, double - `MembersOnlyProductDiscount` number, double - `AllowInSSI` boolean - `AllowUnpaidAppointmentBooking` boolean - `AllowNonMemberServicePurchases` boolean - `IconPlainList` integer[] - `IconWithMList` integer[] - `IconList` integer[] - `IconNumber` integer - `AllowClientModeUnpaidScheduling` boolean - `Active` boolean - `IsSystem` boolean - `AllowNonMemberProductPurchases` boolean - `ScheduleOpenDayOfMonth` integer - `MembershipImgURL` string - `Use2013Workflow` boolean - `ID` integer - `Name` string, required - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `Staff` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `ID` integer - `VisitDataID` integer - `ClientID` integer - `StaffID` integer - `SessionTypeID` integer - `SessionTypeName` string - `LateCancelled` boolean - `EarlyCancelled` boolean - `LocationID` integer - `ClientSeriesID` integer - `ProgramID` integer - `BookedOnline` boolean - `ModifiedDateTime` string, date-time - `Notes` string - `Confirmed` boolean - `Completed` boolean - `Arrived` boolean - `Status` 'Booked' | 'Completed' | 'Confirmed' | 'Arrived' | 'NoShow' | 'Cancelled' - `ModifiedByID` integer - `BookedByID` integer - `BookedDateTime` string, date-time - `RequestedStaffID` integer - `AppointmentOfAddOnID` integer - `MBFBookingID` integer - `ConfirmedByID` integer - `ConfirmedDateTime` string, date-time - `StaffGetsPaid` boolean - `Missed` boolean - `CurrentSeries` boolean - `Lock` boolean - `Closed` boolean - `ClosedRevenue` boolean - `Recurring` boolean - `Full` boolean - `Pending` boolean - `NumDeducted` integer - `EmailReminderSent` boolean - `MobileReminderSent` boolean - `EmailFollowupSent` boolean - `StaffSessionTypeRateID` integer - `Waitlist` boolean - `Studio` integer - `OldClientID` integer - `ParentStaffScheduleID` integer - `ReservedFor` string - `ReservedByClientID` integer - `RESTSource` string - `Program` MindbodyRestApiCommonModelsSiteProgramsAppointmentProgram - `Color` string - `DefaultCapacity` integer - `SchedOffset` integer - `SchedOffsetEnd` integer - `Asst1PayrollCode` string - `StaffPayrollCode` string - `CancelOffset` integer - `ID` integer - `Name` string - `Active` boolean - `Disabled` boolean - `ShowOnline` boolean - `ProgramType` 'Class' | 'Appointment' | 'Enrollment' | 'Media' | 'Resource' | 'Arrival' - `CancelConMode` boolean - `MembersOnly` boolean - `DefaultBookingLengthInMinutes` integer - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `SessionType` MindbodyRestApiCommonModelsSiteAppointmentSessionType - `Description` string - `DefaultTimeLength` integer, required - `ShowInConsumerMode` boolean - `AddOn` boolean - `BackbarAmount` number, double - `Capacity` integer, required - `MBFSessionTypeID` integer - `MBFAutoMapped` boolean - `MBFFeatured` integer - `CPTID` integer - `ResourceRequired` boolean - `Color` string - `FinishTimeAfterAppt` boolean - `CPTCode` string - `ProductId` integer - `ID` integer - `ProgramID` integer, required - `Name` string, required - `Active` boolean - `Deleted` boolean - `Locked` boolean - `SortOrder` integer, required - `PayrollIdentifier` string - `NumberDeducted` integer, required - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `ConfirmedBy` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `BookedBy` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `ModifiedBy` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `RequestedStaff` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `PrepFinishUnavailabilities` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `Location` MindbodyRestApiCommonModelsSiteLocation - `ID` integer - `Name` string - `Active` boolean - `InvActive` boolean - `WsShow` boolean - `Phone` string - `Ext` string - `Address` string - `Email` string - `ContactName` string - `ShipAddress` string - `ShipCity` string - `ShipState` string - `ShipPostal` string - `ShipPhone` string - `ShipPoc` string - `TaxGrouping` boolean - `Tax1` number, float - `Tax2` number, float - `Tax3` number, float - `Tax4` number, float - `LabelTax1` string - `LabelTax2` string - `LabelTax3` string - `LabelTax4` string - `Wac` boolean - `Address2` string - `CsiAlertNonPreReg` boolean - `CsiPrtReceipts` boolean - `Mid` string - `Tid` string - `OpAcctNum` string - `Tax5` number, float - `LabelTax5` string - `AutoInactiveClients` integer - `EnableAutoBatch` boolean - `HostStudioID` integer - `FtpUsername` string - `FtpPassword` string - `FtpHeaderRecord` string - `AdpCoCode` string - `ShipAddress2` string - `MasterLocID` integer - `BankClientID` string - `BatchProcessing` boolean - `StreetAddress` string - `City` string - `StateProvCode` string - `PostalCode` string - `Longitude` number, double - `Latitude` number, double - `LocationDescription` string - `Country` string - `StudioID` integer - `VATIdentificationNumber` string - `EnableTax1` boolean - `EnableTax2` boolean - `EnableTax3` boolean - `EnableTax4` boolean - `EnableTax5` boolean - `FacilitySquareFeet` integer - `NumberTreatmentRooms` integer - `TaxRate1DefaultLabel` string - `TaxRate2DefaultLabel` string - `TaxRate3DefaultLabel` string - `TaxRate4DefaultLabel` string - `TaxRate5DefaultLabel` string - `StudioName` string - `StudioShort` string - `SubscriptionLevel` string - `DistanceInMiles` number, float - `ImageVersion` integer - `CountryCode` string - `BusinessDescription` string - `StudioAllowsGeofencedCheckins` boolean - `UserFavoriteLocation` boolean - `OptedInToConnect` boolean - `ThirdPartyMonetizationOptIn` boolean - `TotalConnectRatings` integer - `AverageConnectRating` number, double - `Locale` string - `SpecialCurrencyID` integer - `ExchangeApproved` boolean - `OnlineBooking` boolean - `Website` string - `ModifiedDateTimeUTC` string, date-time - `TimezoneId` string - `TotalDeals` integer - `ShowInventoryToThirdParties` boolean - `BillingAccountId` string - `HasClasses` boolean - `SiteId` integer - `ReservedByClient` MindbodyRestApiCommonModelsSiteClientsClientMedium - `ExternalID` string - `OptedIn` boolean - `OptedInForPromotions` boolean - `WorkPhone` string - `WorkExtension` string - `HomePhone` string - `MobilePhone` string - `Email` string - `YellowAlert` string - `RedAlert` string - `GenderPreference` 'None' | 'Male' | 'Female' - `IsSystem` boolean - `FirstApptDate` string, date-time - `Inactive` boolean - `CommunicationPreferences` MindbodyRestApiCommonModelsSiteClientsClientNotificationPreferences - `ClientId` integer - `StudioId` integer - `PromotionalEmailOptIn` boolean - `PromotionalTextOptIn` boolean - `ScheduleEmailOptIn` boolean - `ScheduleTextOptIn` boolean - `AccountEmailOptIn` boolean - `AccountTextOptIn` boolean - `OperationalEmailOptIn` boolean - `TwilioOptIn` boolean - `LegacyPreferences` MindbodyRestApiCommonModelsSiteClientsLegacyClientNotificationPreferences - `OptedIn` boolean - `OptedInForPromotions` boolean - `AutomatedContactMethod` 'NormalOnly' | 'MobileOnly' | 'MobileAndNormal' - `OptOutSMSSentDateUTC` string, date-time - `Name` string - `NameFormattedForAppointmentSchedule` string - `IsCompany` boolean - `FormulaNotes` MindbodyRestApiCommonModelsSiteFormulaNote[] - `ID` integer - `ClientID` integer - `Note` string - `EntryDateTime` string, date-time - `CreatedByID` integer - `AppointmentID` integer - `CreatedBy` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `ClientMembership` MindbodyRestApiCommonModelsSiteClientMembership - `ID` integer - `ClientID` integer - `ActiveDate` string, date-time - `ExpDate` string, date-time - `SeriesTypeName` string - `TypePurch` string - `SeriesTypeID` integer - `IconNum` integer - `SeriesType` MindbodyRestApiCommonModelsSiteMembershipSeriesType - `SortOrder` integer - `MembersOnlyServiceDiscount` number, double - `MembersOnlyProductDiscount` number, double - `AllowInSSI` boolean - `AllowUnpaidAppointmentBooking` boolean - `AllowNonMemberServicePurchases` boolean - `IconPlainList` integer[] - `IconWithMList` integer[] - `IconList` integer[] - `IconNumber` integer - `AllowClientModeUnpaidScheduling` boolean - `Active` boolean - `IsSystem` boolean - `AllowNonMemberProductPurchases` boolean - `ScheduleOpenDayOfMonth` integer - `MembershipImgURL` string - `Use2013Workflow` boolean - `ID` integer - `Name` string, required - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `ClientSeries` MindbodyRestApiCommonModelsSiteOldClientSeriesMedium - `ID` integer - `Name` string - `Duration` integer - `DurationUnit` integer - `SeriesTypeID` integer - `NumberOfClasses` integer - `Remaining` integer - `RealRemaining` integer - `Count` integer - `IsReturned` boolean - `ActiveDate` string, date-time - `PaymentDate` string, date-time - `ExpirationDate` string, date-time - `ActivatesOnFirstVisit` boolean - `IsCurrentSeries` boolean - `AllUsedUp` boolean - `ProductID` integer - `SeriesType` MindbodyRestApiCommonModelsSiteMembershipSeriesType - `SortOrder` integer - `MembersOnlyServiceDiscount` number, double - `MembersOnlyProductDiscount` number, double - `AllowInSSI` boolean - `AllowUnpaidAppointmentBooking` boolean - `AllowNonMemberServicePurchases` boolean - `IconPlainList` integer[] - `IconWithMList` integer[] - `IconList` integer[] - `IconNumber` integer - `AllowClientModeUnpaidScheduling` boolean - `Active` boolean - `IsSystem` boolean - `AllowNonMemberProductPurchases` boolean - `ScheduleOpenDayOfMonth` integer - `MembershipImgURL` string - `Use2013Workflow` boolean - `ID` integer - `Name` string, required - `ReservedByClientNameString` string - `GenderPreference` 'None' | 'Male' | 'Female' - `Capacity` integer - `BookedOnFinder` boolean - `PaymentApplied` boolean - `StaffRequested` boolean - `SystemClient` boolean - `PrepTime` integer - `FinishTime` integer - `AddOns` MindbodyRestApiCommonModelsSiteAddOn[] - `ID` integer - `AppointmentReference` integer - `ServiceCategoryReference` integer - `ServiceCategory` MindbodyRestApiCommonModelsSiteProgramsAppointmentProgram - `Color` string - `DefaultCapacity` integer - `SchedOffset` integer - `SchedOffsetEnd` integer - `Asst1PayrollCode` string - `StaffPayrollCode` string - `CancelOffset` integer - `ID` integer - `Name` string - `Active` boolean - `Disabled` boolean - `ShowOnline` boolean - `ProgramType` 'Class' | 'Appointment' | 'Enrollment' | 'Media' | 'Resource' | 'Arrival' - `CancelConMode` boolean - `MembersOnly` boolean - `DefaultBookingLengthInMinutes` integer - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `AppointmentTypeReference` integer - `AppointmentType` MindbodyRestApiCommonModelsSiteAppointmentSessionType - `Description` string - `DefaultTimeLength` integer, required - `ShowInConsumerMode` boolean - `AddOn` boolean - `BackbarAmount` number, double - `Capacity` integer, required - `MBFSessionTypeID` integer - `MBFAutoMapped` boolean - `MBFFeatured` integer - `CPTID` integer - `ResourceRequired` boolean - `Color` string - `FinishTimeAfterAppt` boolean - `CPTCode` string - `ProductId` integer - `ID` integer - `ProgramID` integer, required - `Name` string, required - `Active` boolean - `Deleted` boolean - `Locked` boolean - `SortOrder` integer, required - `PayrollIdentifier` string - `NumberDeducted` integer, required - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `Staff` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `StaffReference` integer - `BookedOnline` boolean - `ClientSeriesReference` integer - `PaymentApplied` boolean - `Pending` boolean - `Completed` boolean - `RESTSource` string - `Appointment` MindbodyRestApiCommonModelsSiteAppointment — recursive - `AdditionalAppointments` MindbodyRestApiCommonModelsSiteAdditionalAppointment[] - `ID` integer - `StaffID` integer - `ProgramID` integer - `SessionTypeID` integer - `ScheduleItemId` integer - `ScheduleItemName` string - `ScheduleItemType` 'Appointment' | 'ClassInstance' | 'Unavailability' - `Start` string, date-time - `End` string, date-time - `Resources` MindbodyRestApiCommonModelsSiteResource[] - `ID` integer - `Name` string, required - `LocationID` integer, required - `Quantity` integer - `Active` boolean - `ResourceTypeID` integer - `Resv` boolean - `Appt` boolean - `Enroll` boolean - `SortOrder` integer - `ShowOnPDF` boolean - `FormulaNotes` MindbodyRestApiCommonModelsSiteFormulaNote[] - `ID` integer - `ClientID` integer - `Note` string - `EntryDateTime` string, date-time - `CreatedByID` integer - `AppointmentID` integer - `CreatedBy` MindbodyRestApiCommonModelsSiteStaffSmall - `PermissionGroupName` string - `SModeID` integer - `DisplayName` string - `SortOrder` integer - `EmailAddress` string - `Name` string - `Appointments` MindbodyRestApiCommonModelsSiteAppointment[] - `AppointmentPayRates` MindbodyRestApiCommonModelsSiteAppointmentPayRate[] - `ID` integer - `StaffID` integer - `AppointmentSessionTypeID` integer - `PayAmount` number, double - `TimeLength` integer, required - `PercentPay` number, float - `PrepTime` integer - `FinishTime` integer - `PrepTimeBak` integer - `FinishTimeBak` integer - `Active` boolean - `StaffPrice` number, double - `DefaultPrice` number, double - `CreatedBy` integer - `LastModifiedBy` integer - `LastModifiedOn` string, date-time - `StaffSchedules` MindbodyRestApiCommonModelsSiteStaffSchedule[] - `ID` integer - `StaffID` integer - `Updated` string, date-time - `Created` string, date-time - `DaySun` boolean - `DayMon` boolean - `DayTue` boolean - `DayWed` boolean - `DayThu` boolean - `DayFri` boolean - `DaySat` boolean - `ShowPublic` boolean - `MaskPublic` boolean - `Unavailable` boolean - `AvailName` string - `Location` integer - `ClassID` integer - `TGs` integer[] - `SingleDayAvailability` boolean - `VisitRefNo` integer - `ToBeDetermined` boolean - `Description` string - `GroupId` integer - `DaysOfWeek` string[] - `StartTime` string - `EndTime` string - `StartDate` string, date-time - `EndDate` string, date-time - `ID` integer - `FirstName` string, required - `LastName` string, required - `UserName` string - `HomeSiteID` integer - `UserGuid` string, uuid - `ICDCodeIDs` integer[] - `CPTModifiers` string[] - `StaffProviderID` integer - `CPTUnits` integer - `ProgressNote` MindbodyRestApiCommonModelsSiteProgressNotesAppointmentProgressNoteSummary - `AppointmentId` integer - `CreatedBySmodeId` integer - `ModifiedBySmodeId` integer - `CreatedDate` string, date-time - `ModifiedDate` string, date-time - `NoteModified` boolean - `SaveState` 'Unsaved' | 'InProgress' | 'Complete' - `CreatedByDisplayName` string - `ModifiedByDisplayName` string - `CreatedByFirstName` string - `CreatedByLastName` string - `ModifiedByFirstName` string - `ModifiedByLastName` string - `ScheduleItemId` integer - `ScheduleItemName` string - `ScheduleItemType` 'Appointment' | 'ClassInstance' | 'Unavailability' - `Start` string, date-time - `End` string, date-time - `AppointmentPayRates` MindbodyRestApiDtoModelsSiteAppointmentPayRate[] — Appointment pay rates for the given staff member. - `ID` integer — Unique identifier - `StaffID` integer — Staff member the Pay Rate belongs to - `AppointmentSessionTypeID` integer — Session type identifier that generally maps to the VisitTypeID - `PayRateType` 'NoPay' | 'FlatPay' | 'PercentPay' — Pay rate type that generally maps to the PayRateTypeId - `PayRateTypeLocalizedName` string — Localized name in cases where there is a Pay Rate Type - `LanguageCategory` string — Language category for the pay rate - `LanguagePhrase` string — Language phrase for the pay rate - `PayAmount` number, double — The pay amount for the staff member - `PercentPay` number, float — Pay percentage for the staff member - `TimeLength` integer — The length of the visit in minutes. - `PrepTime` integer — The length of the prep time in minutes. - `FinishTime` integer — The length of the finish time in minutes. - `PrepTimeBak` integer — Prep time for staff member - `FinishTimeBak` integer — Finish time for staff member - `Active` boolean — Whether the Pay Rate is active (true) or inactive (false) for the Staff member. - `StaffPrice` number, double — Pay rate staff price - `DefaultPrice` number, double — Default price for the pay rate - `CreatedBy` integer — Unique idenifier for the creator of the pay rate. - `CreationDateTime` string, date-time — Date time that the pay rate was created. - `LastModifiedBy` integer — Unique idenifier for the user who last modified the pay rate. - `LastModifiedOn` string, date-time — The date that the pay rate was last modified on. - `StaffSchedules` MindbodyRestApiDtoModelsSiteStaffSchedule[] — Schedules for the given staff member. - `ID` integer — Unique identifier for the staff schedule - `StaffID` integer — Staff that the schedule belongs to - `StartTime` string — Scheduled start time - `EndTime` string — Scheduled end time - `StartDate` string, date-time — Scheduled start date - `EndDate` string, date-time — Scheduled end date - `Updated` string, date-time — Date when schedule was last updated - `Created` string, date-time — Date when schedule was created - `DaySun` boolean — Whether this schedule is available on Sunday or not. - `DayMon` boolean — Whether this schedule is available on Monday or not. - `DayTue` boolean — Whether this schedule is available on Tuesday or not. - `DayWed` boolean — Whether this schedule is available on Wednesday or not. - `DayThu` boolean — Whether this schedule is available on Thursday or not. - `DayFri` boolean — Whether this schedule is available on Friday or not. - `DaySat` boolean — Whether this schedule is available on Saturday or not. - `ShowPublic` boolean — Whether to show publicly or not. - `MaskPublic` boolean — Whether to mask from public or not. - `Unavailable` boolean — Whether the staff is unavailable or not. - `AvailName` string — Available name for the schedule - `Location` integer — Location associated with the schedule, if any. - `ClassID` integer — Class associated with the schedule, if any. - `TGs` integer[] — The list of TypeGroups associated with the schedule - `SingleDayAvailability` boolean — Whether the schedule is available on a single day or not. - `VisitRefNo` integer — The VisitRefNo for the schedule - `ToBeDetermined` boolean — Whether or not the schedule is for a TBD class - `Description` string — The description of this schedule. Note this is created from a view StaffScheduleDescription that must be exclicitly loaded - `DaysOfWeek` string[] — Days of the week for the schedule - `GroupId` integer — Schedule group unique identifier ## Other responses - `400` — BadRequest - `401` — Unauthorized --- [API](https://skmtc.net/mindbodyonline/apis/rest-api.md) · [All operations](https://skmtc.net/mindbodyonline/apis/rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mindbodyonline/rest-api/revisions/dc2736850e42/schema)