List customers

Namespace: microsoft.graph

Get a list of bookingCustomer objects of a business.

This API is supported in the following national cloud deployments.

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

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Bookings.Read.All, BookingsAppointment.ReadWrite.All, Bookings.ReadWrite.All, Bookings.Manage.All
Delegated (personal Microsoft account)	Not supported.
Application	Not supported.

HTTP request

GET /solutions/bookingBusinesses/{id}/customers

Optional query parameters

This method supports the $count and $expand OData query parameters to help customize the response.

Request headers

Name	Description
Authorization	Bearer {code}

Request body

Do not supply a request body for this method.

Response

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

Example

Request

The following is an example of the request.

HTTP

GET https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/Contosolunchdelivery@contoso.onmicrosoft.com/customers

C#

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

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Solutions.BookingBusinesses["{bookingBusiness-id}"].Customers.GetAsync();

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

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc solutions booking-businesses customers list --booking-business-id {bookingBusiness-id}

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

Go

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



customers, err := graphClient.Solutions().BookingBusinesses().ByBookingBusinessId("bookingBusiness-id").Customers().Get(context.Background(), nil)

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

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

BookingCustomerBaseCollectionPage customers = graphClient.solutions().bookingBusinesses("Contosolunchdelivery@contoso.onmicrosoft.com").customers()
	.buildRequest()
	.get();

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let customers = await client.api('/solutions/bookingBusinesses/Contosolunchdelivery@contoso.onmicrosoft.com/customers')
	.get();

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

PHP

<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->solutions()->bookingBusinesses()->byBookingBusinessId('bookingBusiness-id')->customers()->get()->wait();

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

PowerShell

Import-Module Microsoft.Graph.Bookings

Get-MgBookingBusinessCustomer -BookingBusinessId $bookingBusinessId

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

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)


result = await graph_client.solutions.booking_businesses.by_booking_businesse_id('bookingBusiness-id').customers.get()

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

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/solutions/$metadata#bookingBusinesses('Contosolunchdelivery%40contoso.onmicrosoft.com')/customers",
    "value": [
        {
            "@odata.type": "#microsoft.graph.bookingCustomer",
            "id": "80b5ddda-1e3b-4c9d-abe2-d606cc075e2e",
            "displayName": "Adele Vance",
            "emailAddress": "adelev@proseware.com",
            "addresses": [],
            "phones": []
        },
        {
            "@odata.type": "#microsoft.graph.bookingCustomer",
            "id": "8bb19078-0f45-4efb-b2c5-da78b860f73a",
            "displayName": "Adele Vance",
            "emailAddress": "adelev@proseware.com",
            "addresses": [
                {
                    "postOfficeBox":"",
                    "street":"4567 Main Street",
                    "city":"Buffalo",
                    "state":"NY",
                    "countryOrRegion":"USA",
                    "postalCode":"98052",
                    "type":"home"
                },
                {
                    "postOfficeBox":"",
                    "street":"4570 Main Street",
                    "city":"Buffalo",
                    "state":"NY",
                    "countryOrRegion":"USA",
                    "postalCode":"98054",
                    "type":"business"
                }
            ],
            "phones": [
                {
                    "number": "206-555-0100",
                    "type": "home"
                },
                {
                    "number": "206-555-0200",
                    "type": "business"
                }
            ]
        },
        {
            "@odata.type": "#microsoft.graph.bookingCustomer",
            "id": "829e3cb5-3d4d-4319-a8de-1953aedaa166",
            "displayName": "Bob Kelly",
            "emailAddress": "bobk@tailspintoys.com",
            "addresses": [],
            "phones": []
        },
        {
            "@odata.type": "#microsoft.graph.bookingCustomer",
            "id": "7ed53fa5-9ef2-4f2f-975b-27447440bc09",
            "displayName": "Jordan Miller",
            "emailAddress": "jordanm@contoso.com",
            "addresses": [],
            "phones": []
        }
    ]
}