List bookingBusinesses

Article
02/09/2024

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 {code}

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BookingBusinesses.GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta solutions booking-businesses list

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



bookingBusinesses, err := graphClient.Solutions().BookingBusinesses().Get(context.Background(), nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

BookingBusinessCollectionResponse result = graphClient.solutions().bookingBusinesses().get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let bookingBusinesses = await client.api('/solutions/bookingbusinesses')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->solutions()->bookingBusinesses()->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.solutions.booking_businesses.get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BookingBusinesses.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Query = "Adventure";
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta solutions booking-businesses list

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphsolutions "github.com/microsoftgraph/msgraph-beta-sdk-go/solutions"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestQuery := "Adventure"

requestParameters := &graphsolutions.SolutionsBookingBusinessesRequestBuilderGetQueryParameters{
	Query: &requestQuery,
}
configuration := &graphsolutions.SolutionsBookingBusinessesRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

bookingBusinesses, err := graphClient.Solutions().BookingBusinesses().Get(context.Background(), configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

BookingBusinessCollectionResponse result = graphClient.solutions().bookingBusinesses().get(requestConfiguration -> {
	requestConfiguration.queryParameters.query = "Adventure";
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let bookingBusinesses = await client.api('/solutions/bookingbusinesses?query=Adventure')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Solutions\BookingBusinesses\BookingBusinessesRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new BookingBusinessesRequestBuilderGetRequestConfiguration();
$queryParameters = BookingBusinessesRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->query = "Adventure";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->solutions()->bookingBusinesses()->get($requestConfiguration)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


from msgraph import GraphServiceClient
from msgraph.generated.solutions.booking_businesses.booking_businesses_request_builder import BookingBusinessesRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = BookingBusinessesRequestBuilder.BookingBusinessesRequestBuilderGetQueryParameters(
		query = "Adventure",
)

request_configuration = BookingBusinessesRequestBuilder.BookingBusinessesRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.solutions.booking_businesses.get(request_configuration = request_configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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",
        }
    ]
}

List bookingBusinesses

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Example 1: Get the Bookings buinsesses in a tenant

Request

Response

Example 2: Query parameter

Request

Response

Feedback

Feedback

Additional resources