user: findRooms

Article
06/21/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 the emailAddress objects that represent all the meeting rooms in the user's tenant or in a specific room list.

Tenants can organize meeting rooms into room lists. In this API, each meeting room and room list is represented by an emailAddress instance. You can get all the room lists in the tenant, get all the rooms in the tenant, or get all the rooms in a specific room list. You can get up to the first 100 rooms in the tenant.

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)	User.Read	User.Read.All, User.ReadBasic.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

To get all the rooms in the tenant:

HTTP

GET /me/findRooms
GET /users/{id}/findRooms

To get all the rooms in a specific room list of the tenant's:

HTTP

GET /me/findRooms(RoomList='{room_list_emailAddress}')
GET /users/{id}/findRooms(RoomList='{room_list_emailAddress}')

Query parameters

Query parameter	Type	Description
RoomList	string	The SMTP address associated with the room list. Each room list is represented by an emailAddress instance that includes an SMTP address.

Request headers

Name	Type	Description
Authorization	string	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	string	application/json. Required.

Request body

Don't supply a request body for this method.

Response

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

Examples

Example 1: Get all email addresses by the signed-in user

Request

The following is an example that gets the emailAddress objects that represent all the rooms defined in the signed-in user's tenant.

msgraph

GET https://graph.microsoft.com/beta/me/findRooms


// 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.Me.FindRooms.GetAsFindRoomsGetResponseAsync();

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.

Bash



mgc-beta users find-rooms get --user-id {user-id}

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 major version. Current major version is $v0.*

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
findRooms, err := graphClient.Me().FindRooms().GetAsFindRoomsGetResponse(context.Background(), nil)

Important

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

Java


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.me().findRooms().get();

Important

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 findRooms = await client.api('/me/findRooms')
	.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


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


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


$result = $graphServiceClient->me()->findRooms()->get()->wait();

Important

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.Beta.Users.Functions

# A UPN can also be used as -UserId.
Find-MgBetaUserRoom -UserId $userId

Important

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

Python


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.find_rooms.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.

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

HTTP

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.emailAddress)",
    "value": [
        {
            "name": "Conf Room Adams",
            "address": "Adams@contoso.com"
        },
        {
            "name": "Conf Room Baker",
            "address": "Baker@contoso.com"
        },
        {
            "name": "Conf Room Crystal",
            "address": "Crystal@contoso.com"
        },
        {
            "name": "Conf Room Hood",
            "address": "Hood@contoso.com"
        },
        {
            "name": "Conf Room Rainier",
            "address": "Rainier@contoso.com"
        },
        {
            "name": "Conf Room Stevens",
            "address": "Stevens@contoso.com"
        }
    ]
}

Example 2: Get all email addresses by the specified room list

Request

The second example gets the emailAddress objects that represent the rooms in the specified room list identified by the email address Building2Rooms@contoso.com.

msgraph

GET https://graph.microsoft.com/beta/me/findRooms(RoomList='Building2Rooms@contoso.com')

Snippet not available

Important

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

Snippet not available

Important

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

Snippet not available

Important

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

Snippet not available

Important

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 findRooms = await client.api('/me/findRooms(RoomList='Building2Rooms@contoso.com')')
	.version('beta')
	.get();

Important

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

Snippet not available

Important

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

Snippet not available

Important

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

Snippet not available

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.

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

HTTP

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.emailAddress)",
    "value": [
        {
            "name": "Conf Room Baker",
            "address": "Baker@contoso.com"
        },
        {
            "name": "Conf Room Hood",
            "address": "Hood@contoso.com"
        },
        {
            "name": "Conf Room Rainier",
            "address": "Rainier@contoso.com"
        }
    ]
}

Share via

user: findRooms

Permissions

HTTP request

Query parameters

Request headers

Request body

Response

Examples

Example 1: Get all email addresses by the signed-in user

Request

Response

Example 2: Get all email addresses by the specified room list

Request

Response

Feedback

Additional resources