List bookingBusinesses

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a collection of bookingBusiness objects that has been created for the tenant.

This operation returns only the id and displayName of each Microsoft Bookings business in the collection. For performance considerations, it does not return other properties. You can get the other properties of a Bookings business by specifying its id in a GET operation.

You can also query for Bookings businesses by specifying a string in a query parameter to do substring matching among the businesses of a tenant. For details, see Example 2.

Note: Results are limited to 500 mailboxes. Pagination of the results is not currently supported.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Bookings.Read.All Bookings.Manage.All, Bookings.ReadWrite.All, BookingsAppointment.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application Bookings.Read.All Bookings.Manage.All, Bookings.ReadWrite.All

HTTP request

GET /solutions/bookingbusinesses

Optional query parameters

This method supports some of the OData query parameters to help customize the response.

This method also supports the query parameter which accepts a string value. This parameter limits the GET results to businesses that match the specified string.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and collection of bookingBusiness objects in the response body.

Examples

Example 1: Get the Bookings buinsesses in a tenant

Request

The following example gets the Bookings businesses in a tenant.

GET https://graph.microsoft.com/beta/solutions/bookingbusinesses

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#solutions/bookingBusinesses",
    "value":[
        {
            "id":"Contosolunchdelivery@contoso.com",
            "displayName":"Contoso lunch delivery",
        },
        {
            "id":"Fabrikam@contoso.com",
            "displayName":"Fabrikam",
        }
    ]
}

Example 2: Query parameter

Request

The following example shows how to use the query parameter to get one or more matching Bookings businesses in the tenant.

GET https://graph.microsoft.com/beta/solutions/bookingbusinesses?query=Adventure

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#solutions/bookingBusinesses",
    "value":[
        {
            "id":"AdventureWorksCycles@contoso.com",
            "displayName":"Adventure Works Cycles",
        }
    ]
}