MImindbodyonline
Rest

The way to find all staff or a single staff member.

get/Users/Staff

Request

Query parameters

request.staffIdsinteger[]

(optional) A requested list of staffIDs.

request.staffCredentials.usernamestring

Username of the staff member.

request.staffCredentials.passwordstring

Password of the staff member.

request.staffCredentials.siteIdsinteger[]

A list of Sites / Subscribers that the staff member has access to.

request.filtersstring[]

(optional) A list of filters applied to the search.

request.sessionTypeIdinteger

(optional) Filter search by staff that are available for specified SessionTypeID. Must be used with a valid StartDateTime value and LocationID.

request.startDateTimestring date-time

(optional) Filter search by staff that are available at specified date and time. Must be used with a valid SessionTypeID and LocationID.

request.locationIdinteger

(optional) Filter search by staff that are available at specified location. Must be used with a valid SessionTypeID and StartDateTime.

Headers

SiteIdinteger required

Site ID

Response

OK

Nicknamestring

Nickname for the staff member. Maps to TrDear in DB.

Addressstring

Address of the staff member.

Address2string

Second line of the address of the staff member.

Citystring

The city the staff is in.

Statestring

The state the staff is in.

PostalCodestring

The postal code for the staff.

ForeignZipstring

Foreign postal code for staff

Countrystring

The country the staff is in.

WorkPhonestring

The work phone number for the staff.

WorkExtstring

The work extension number for the staff's work phone number.

HomePhonestring

The home phone number for the staff member.

CellPhonestring

The cell phone number of the staff.

PhoneNumberstring

Computed between the three available

Pagerstring

The pager number of the staff if applicable.

FaxNumberstring

The fax number of the staff.

Birthdatestring date-time

The birthdate of the staff.

Notesstring

The notes for the staff.

Teacherboolean

If the staff is a teacher or not.

MassageTherapistboolean

If the staff is a massage therapist.

WorkshopInstructorboolean

If the staff is a workshop instructor.

Employeeboolean

If the staff is an employee.

Activeboolean

If the staff is active.

Deletedboolean

If the staff is deleted.

Lockedboolean

If the staff is locked.

Locationinteger

The studio location of the staff if there are more than 1 studio location possibilities.

Closedboolean

If the staff is closed.

Assistantboolean

If the staff can be an assistant.

Ssnstring

The social security number of the staff.

Assistant2boolean

If the staff can be an assistant2.

EmpIDstring

The employee ID of the staff.

CanBeAssignedFollowupsboolean

If the staff can be assigned followups. Maps to CRM in the DB.

HourlyRatenumber double

The hourly rate of the staff.

StdStaffCommissionPercRatenumber float

The standard staff commission percent rate.

StdStaffCommissionFlatRatenumber double

The standard staff commission flat rate.

PromoStaffCommissionPercRatenumber float

The promo staff commission flat rate.

PromoStaffCommissionFlatRatenumber double

The promo staff commission flat rate.

EarnsCommissionsboolean

If the staff earns commissions.

AppointmentStaffboolean

If the staff is an appointment trainer.

ReservationStaffboolean

If the staff is a reservation trainer.

DefaultDeptIDstring

The default department ID of the staff.

Rep1boolean

If the staff is a rep1 for clients.

Rep2boolean

If the staff is a rep2 for clients.

Rep3boolean

If the staff is a rep3 for clients.

Rep4boolean

If the staff is a rep4 for clients.

Rep5boolean

If the staff is a rep5 for clients.

Rep6boolean

If the staff is a rep6 for clients.

EarnsTipsboolean

If the staff earns tips.

HideInPayrollExportboolean

If the staff is hidden in payroll exports.

DisableAttachmentsboolean

If the staff has attachments disabled.

EmploymentEndstring date-time

The staff's Employment end date.

EmploymentStartstring date-time

The staff's Employment start date.

IndependentContractorboolean

If the staff is an independent contractor.

GoogleCalUserNamestring

The google calendar user name for the staff.

GoogleCalIDstring

The google calendar ID for the staff.

MobileProviderinteger

The Mobile provider enum for the staff.

AutomatedContactMethodinteger

The automated contact method for the staff.

IsSystemboolean

If the staff is a system staff.

LastGoogleSyncStartstring date-time

The date of the last google sync start.

LastGoogleSyncEndstring date-time

The date of the last google sync end.

AlwaysAllowDoubleBookingboolean

If double booking is always allowed.

NameForDropDownstring

Name of the staff member.

ImageURLstring

The staff member's profile image URL. It will not be returned if it does not exist.

IsSalesRepboolean

Whether or not this staff member can be a client rep.

IsOwnerboolean

If the staff is a HIPAA-fied owner.

MindbodyEmailOptInboolean

Whether the staff is opted in for Mindbody emails.

CreationDateTimestring date-time

Creation date of the staff member.

UserAccessLevelstring

User access level for the staff. Note: This is only available when providing staff credentials.

IsServiceProviderboolean

Flag set for staff that have had services booked within last 30 days.

Genderboolean

Gender of the staff member. Male if true, female if false.

Biostring

The staff member's biography information.

IDinteger

Unique identifier for the staff member.

UserGuidstring uuid

GUID for the staff member.

PermissionGroupNamestring

Permission group name for the staff member. Usually maps to 'status' in DB.

SModeIDinteger

The user unique identifier for the staff member.

DisplayNamestring

The display name for the staff member.

SortOrderinteger

Integer that represents the sort order for the staff member.

EmailAddressstring

Staff member's email address.

FirstNamestring

Staff member's first name.

LastNamestring

Staff member's last name.

Namestring

The Full Name of this staff, a calculated field that returns the FirstName + " " + LastName

UserNamestring

The username of this staff

HomeSiteIDinteger

The homesite ID of this staff

Changes

No recorded changes to this operation across all 3 revisions of this API.