bookingBusiness resource type

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

Represents a business in Microsoft Bookings. This is the top level object in the Microsoft Bookings API. It contains business information and related business objects such as appointments, customers, services, and staff members.

Methods

Method Return Type Description
List bookingBusinesses bookingBusiness collection Get a collection of bookingbusiness objects in the tenant.
Create bookingBusiness bookingBusiness Create a new Microsoft Bookings business.
Get bookingBusiness bookingBusiness Read properties and relationships of bookingBusiness object.
Update bookingBusiness Update properties in a bookingBusiness object.
Delete None Delete a bookingBusiness object.
Create bookingAppointment bookingAppointment Create a new bookingAppointment by posting to the appointments collection.
List appointments bookingAppointment collection Get a bookingAppointment object collection.
Create bookingCustomer bookingCustomer Create a new bookingCustomer by posting to the customers collection.
List customers bookingCustomer collection Get a bookingCustomer object collection.
Create bookingService bookingService Create a new bookingService by posting to the services collection.
List services bookingService collection Get a bookingService object collection.
Create bookingStaffMember bookingStaffMember Create a new bookingStaffMember by posting to the staffMembers collection.
List staffMembers bookingStaffMember collection Get a bookingStaffMember object collection.
List calendarView bookingAppointment collection Get the collection of bookingAppointment objects that occurs in the specified date range.
publish None Make the scheduling page of this business available to external customers. Set the isPublished property to true, and publicUrl property to the URL of the scheduling page.
unpublish None Make the scheduling page of this business not available to external customers. Set the isPublished property to false, and publicUrl property to null.

Properties

Property Type Description
address physicalAddress The street address of the business. The address property, together with phone and webSiteUrl, appear in the footer of a business scheduling page.
businessHours bookingWorkHours collection The hours of operation for the business.
businessType String The type of business.
defaultCurrencyIso String The code for the currency that the business operates in on Microsoft Bookings.
displayName String The name of the business, which interfaces with customers. This name appears at the top of the business scheduling page.
email String The email address for the business.
id String A unique programmatic identifier for the business. Read-only.
isPublished Boolean The scheduling page has been made available to external customers. Use the publish and unpublish actions to set this property. Read-only.
phone String The telephone number for the business. The phone property, together with address and webSiteUrl, appear in the footer of a business scheduling page.
publicUrl String The URL for the scheduling page, which is set after you publish or unpublish the page. Read-only.
schedulingPolicy bookingSchedulingPolicy Specifies how bookings can be created for this business.
webSiteUrl String The URL of the business web site. The webSiteUrl property, together with address, phone, appear in the footer of a business scheduling page.

Relationships

Relationship Type Description
appointments bookingAppointment collection All the appointments of this business. Read-only. Nullable.
calendarView bookingAppointment collection The set of appointments of this business in a specified date range. Read-only. Nullable.
customers bookingCustomer collection All the customers of this business. Read-only. Nullable.
services bookingService collection All the services offered by this business. Read-only. Nullable.
staffMembers bookingStaffMember collection All the staff members that provide services in this business. Read-only. Nullable.

JSON representation

The following is a JSON representation of the resource.

{
  "address": {"@odata.type": "microsoft.graph.physicalAddress"},
  "businessHours": [{"@odata.type": "microsoft.graph.bookingWorkHours"}],
  "businessType": "String",
  "defaultCurrencyIso": "String",
  "displayName": "String",
  "email": "String",
  "id": "String (identifier)",
  "isPublished": true,
  "phone": "String",
  "publicUrl": "String",
  "schedulingPolicy": {"@odata.type": "microsoft.graph.bookingSchedulingPolicy"},
  "webSiteUrl": "String"
}

See also