The identity and technical contract details declared by the specification.
UploadClientPhotoRequest
object
Implementation of the 'UploadClientPhotoRequest' model.
2 properties
GetClientAccountBalancesResponse
object
Implementation of the 'GetClientAccountBalancesResponse' model.
2 properties
ContactLog
object
Implementation of the 'ContactLog' model. A contact log.
11 properties
AddClientDirectDebitInfoResponse
object
Implementation of the 'AddClientDirectDebitInfoResponse' model.
5 properties
AddOnSmall
object
Implementation of the 'AddOnSmall' model.
4 properties
UpdateClientServiceRequest
object
Implementation of the 'UpdateClientServiceRequest' model.
5 properties
Program
object
Implementation of the 'Program' model.
6 properties
GetClientCompleteInfoResponse
object
Implementation of the 'GetClientCompleteInfoResponse' model. Contains information about the requested client.
5 properties
Action8Enum
string
Action8Enum enumeration.
SessionType
object
Implementation of the 'SessionType' model. SessionType contains information about the session types in a business.
13 properties
GetActiveClientsMembershipsResponse
object
Implementation of the 'GetActiveClientsMembershipsResponse' model.
2 properties
MinimumCommitmentUnitEnum
string
MinimumCommitmentUnitEnum enumeration.
ContactLogType
object
Implementation of the 'ContactLogType' model. A contact log type.
3 properties
GetClientVisitsResponse
object
Implementation of the 'GetClientVisitsResponse' model.
2 properties
ClientDocument
object
Implementation of the 'ClientDocument' model.
3 properties
Amenity
object
Implementation of the 'Amenity' model. Definition of a location amenity
2 properties
ClientMembership
object
Implementation of the 'ClientMembership' model.
17 properties
GetActiveClientMembershipsResponse
object
Implementation of the 'GetActiveClientMembershipsResponse' model.
2 properties
UpcomingAutopayEvent
object
Implementation of the 'UpcomingAutopayEvent' model.
7 properties
UploadClientDocumentResponse
object
Implementation of the 'UploadClientDocumentResponse' model.
2 properties
UpdateContactLogRequest
object
Implementation of the 'UpdateContactLogRequest' model.
10 properties
GetClientRewardsResponse
object
Implementation of the 'GetClientRewardsResponse' model.
3 properties
StaffSetting
object
Implementation of the 'StaffSetting' model. contains the information about the staff settings.
2 properties
ClientWithSuspensionInfo
object
Implementation of the 'ClientWithSuspensionInfo' model. A Client DTO with Suspension Information
59 properties
FormulaNoteResponse
object
Implementation of the 'FormulaNoteResponse' model. An individual Client Formula Note.
10 properties
MergeClientsRequest
object
Implementation of the 'MergeClientsRequest' model. Request for clients/mergeclients
2 properties
CrossRegionalClientAssociation
object
Implementation of the 'CrossRegionalClientAssociation' model. A client cross region association
4 properties
CustomClientField
object
Implementation of the 'CustomClientField' model. A custom client field
3 properties
ResourceSlim
object
Implementation of the 'ResourceSlim' model. Contains information about resources, such as rooms.
2 properties
AddContactLogRequest
object
Implementation of the 'AddContactLogRequest' model.
10 properties
ContactLogComment
object
Implementation of the 'ContactLogComment' model. A contact log comment.
4 properties
DirectDebitInfo
object
Implementation of the 'DirectDebitInfo' model.
4 properties
AutopayStatusEnum
string
AutopayStatusEnum enumeration.
ClientContract
object
Implementation of the 'ClientContract' model. A client contract.
23 properties
Unavailability
object
Implementation of the 'Unavailability' model.
4 properties
PurchasedItem
object
Implementation of the 'PurchasedItem' model.
25 properties
UploadClientDocumentRequest
object
Implementation of the 'UploadClientDocumentRequest' model.
2 properties
ContractItem
object
Implementation of the 'ContractItem' model.
7 properties
MembershipTypeRestriction
object
Implementation of the 'MembershipTypeRestriction' model.
2 properties
VisitWithWaitlistInfo
object
Implementation of the 'VisitWithWaitlistInfo' model. A Visit DTO with Waitlist Information
29 properties
SendAutoEmailRequest
object
Implementation of the 'SendAutoEmailRequest' model.
2 properties
UpdateClientContractAutopaysRequest
object
Implementation of the 'UpdateClientContractAutopaysRequest' model.
7 properties
GetClientServicesResponse
object
Implementation of the 'GetClientServicesResponse' model. Contains the response for the GetClientServices endpoint.
2 properties
SuspendContractRequest
object
Implementation of the 'SuspendContractRequest' model.
9 properties
Availability
object
Implementation of the 'Availability' model. A staff availability entry
13 properties
ProspectStage
object
Implementation of the 'ProspectStage' model.
3 properties
TerminateContractResponse
object
Implementation of the 'TerminateContractResponse' model.
1 property
UpdateContactLogComment
object
Implementation of the 'UpdateContactLogComment' model.
2 properties
AddFormulaNoteRequest
object
Implementation of the 'AddFormulaNoteRequest' model.
3 properties
AssignedClientIndex
object
Implementation of the 'AssignedClientIndex' model. Represents a client index value assigned to a client
2 properties
AppointmentGenderPreferenceEnum
string
AppointmentGenderPreferenceEnum enumeration.
UpdateContactLogType
object
Implementation of the 'UpdateContactLogType' model.
2 properties
UpdateClientVisitRequest
object
Implementation of the 'UpdateClientVisitRequest' model.
7 properties
Relationship
object
Implementation of the 'Relationship' model. Jim is a RelationshipName1 of John. John is a RelationshipName2 of Jim.
3 properties
ClientArrival
object
Implementation of the 'ClientArrival' model.
4 properties
ClientPurchaseRecord
object
Implementation of the 'ClientPurchaseRecord' model. A record of a specific client purchase
9 properties
ResourceAvailability
object
Implementation of the 'ResourceAvailability' model. An availability of a resource
3 properties
Action11Enum
string
Action11Enum enumeration.
TerminateContractRequest
object
Implementation of the 'TerminateContractRequest' model.
5 properties
ClientRewardTransaction
object
Implementation of the 'ClientRewardTransaction' model. Contains information about the transaction details.
6 properties
GetCrossRegionalClientAssociationsResponse
object
Implementation of the 'GetCrossRegionalClientAssociationsResponse' model.
2 properties
GetContactLogTypesResponse
object
Implementation of the 'GetContactLogTypesResponse' model.
2 properties
AddArrivalResponse
object
Implementation of the 'AddArrivalResponse' model.
2 properties
Contract
object
Implementation of the 'Contract' model.
38 properties
Sale
object
Implementation of the 'Sale' model. Contains the Sale details.
11 properties
SalePayment
object
Implementation of the 'SalePayment' model.
6 properties
GetClientDuplicatesResponse
object
Implementation of the 'GetClientDuplicatesResponse' model.
2 properties
AppointmentGenderPreference1Enum
string
AppointmentGenderPreference1Enum enumeration.
AppointmentStatusEnum
string
AppointmentStatusEnum enumeration.
AddClientResponse
object
Implementation of the 'AddClientResponse' model.
1 property
ClientService
object
Implementation of the 'ClientService' model. A service that is on a client's account.
14 properties
ClientMemberships
object
Implementation of the 'ClientMemberships' model.
3 properties
UploadClientPhotoResponse
object
Implementation of the 'UploadClientPhotoResponse' model.
2 properties
ClientCreditCard
object
Implementation of the 'ClientCreditCard' model. A client credit card.
10 properties
Staff
object
Implementation of the 'Staff' model. The Staff
38 properties
UpdateClientResponse
object
Implementation of the 'UpdateClientResponse' model.
1 property
AutopaySchedule
object
Implementation of the 'AutopaySchedule' model.
3 properties
ClientSuspensionInfo
object
Implementation of the 'ClientSuspensionInfo' model. A Client DTO with Suspension Information
3 properties
GetClientScheduleResponse
object
Implementation of the 'GetClientScheduleResponse' model.
2 properties
GetRequiredClientFieldsResponse
object
Implementation of the 'GetRequiredClientFieldsResponse' model.
1 property
Location
object
Implementation of the 'Location' model.
25 properties
SalesRep
object
Implementation of the 'SalesRep' model.
5 properties
TypeEnum
string
TypeEnum enumeration.
GetContactLogsResponse
object
Implementation of the 'GetContactLogsResponse' model.
2 properties
GetClientIndexesResponse
object
Implementation of the 'GetClientIndexesResponse' model.
1 property
AddContactLogType
object
Implementation of the 'AddContactLogType' model. Defines what sort of subtypes we want to add to this contact log type
2 properties
Appointment
object
Implementation of the 'Appointment' model. Contains information about an appointment.
23 properties
Client
object
Implementation of the 'Client' model. The Client.
58 properties
VisitWaitlistInfo
object
Implementation of the 'VisitWaitlistInfo' model. A Visit DTO with Waitlist Information
2 properties
Action1Enum
string
Action1Enum enumeration.
ClientServiceWithActivationType
object
Implementation of the 'ClientServiceWithActivationType' model. Represents a pricing option (service) on a client's account, including activation behavior detai…
16 properties
SendPasswordResetEmailRequest
object
Implementation of the 'SendPasswordResetEmailRequest' model. Request to send a password reset email to a user
3 properties
GetClientFormulaNotesResponse
object
Implementation of the 'GetClientFormulaNotesResponse' model. Enables to retrieve cross regional formula notes for a client, or for a specific appointment. The…
2 properties
UpdateClientRequest
object
Implementation of the 'UpdateClientRequest' model.
5 properties
Liability
object
Implementation of the 'Liability' model.
3 properties
ClientType
object
Implementation of the 'ClientType' model. Represents a client's type classification.
2 properties
ClientRelationship
object
Implementation of the 'ClientRelationship' model. A relation between two clients.
5 properties
ClientDuplicate
object
Implementation of the 'ClientDuplicate' model. A client record that is considered a duplicate based on matching of the client's first name, last name, AND emai…
5 properties
ScheduleTypeEnum
string
ScheduleTypeEnum enumeration.
UpdateClientServiceResponse
object
Implementation of the 'UpdateClientServiceResponse' model.
1 property
CustomClientFieldValue
object
Implementation of the 'CustomClientFieldValue' model. The value of a custom client field
4 properties
SuspendContractResponse
object
Implementation of the 'SuspendContractResponse' model.
1 property
ActivationTypeEnum
string
ActivationTypeEnum enumeration.
AppointmentStaff
object
Implementation of the 'AppointmentStaff' model.
4 properties
ClientIndex
object
Implementation of the 'ClientIndex' model. A client index.
6 properties
AddClientRequest
object
Implementation of the 'AddClientRequest' model.
60 properties
UpdateClientRewardsRequest
object
Implementation of the 'UpdateClientRewardsRequest' model. Request object for using the API to Earn or Redeem reward points
6 properties
GetCustomClientFieldsResponse
object
Implementation of the 'GetCustomClientFieldsResponse' model.
2 properties
AddArrivalRequest
object
Implementation of the 'AddArrivalRequest' model.
5 properties
ClientIndexValue
object
Implementation of the 'ClientIndexValue' model. A client index value.
3 properties
GetClientContractsResponse
object
Implementation of the 'GetClientContractsResponse' model.
2 properties
GenderPreferenceEnum
string
GenderPreferenceEnum enumeration.
GetClientsResponse
object
Implementation of the 'GetClientsResponse' model.
2 properties
Visit
object
Implementation of the 'Visit' model. Represents a specific visit to a class
28 properties
PaginationResponse
object
Implementation of the 'PaginationResponse' model. Contains information about the pagination to use.
4 properties
GetClientPurchasesResponse
object
Implementation of the 'GetClientPurchasesResponse' model.
2 properties
ContactLogSubType
object
Implementation of the 'ContactLogSubType' model. A contact log subtype.
2 properties
GetClientReferralTypesResponse
object
Implementation of the 'GetClientReferralTypesResponse' model.
1 property
PaymentMethodEnum
string
PaymentMethodEnum enumeration.
StatusEnum
string
StatusEnum enumeration.
UpdateClientVisitResponse
object
Implementation of the 'UpdateClientVisitResponse' model.
1 property
PricingRelationships
object
Implementation of the 'PricingRelationships' model.
2 properties
AddClientDirectDebitInfoRequest
object
Implementation of the 'AddClientDirectDebitInfoRequest' model.
6 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Mindbody publishes across the network.