Skip to content

user-findrooms.md

Latest commit

 

History

History
259 lines (201 loc) · 8.58 KB

user-findrooms.md

File metadata and controls

259 lines (201 loc) · 8.58 KB
title user: findRooms
description Get all the meeting rooms in the user's tenant or in a specific room list.
ms.localizationpriority high
author vrod9429
ms.subservice outlook
doc_type apiPageType
ms.date 06/21/2024

user: findRooms

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

To get all the rooms in the tenant:

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

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

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.

HTTP

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

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows 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/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.

HTTP

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

C#

[!INCLUDE snippet-not-available] [!INCLUDE sdk-documentation]

Go

[!INCLUDE snippet-not-available] [!INCLUDE sdk-documentation]

Java

[!INCLUDE snippet-not-available] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE snippet-not-available] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE snippet-not-available] [!INCLUDE sdk-documentation]

Python

[!INCLUDE snippet-not-available] [!INCLUDE sdk-documentation]

Response

The following example shows 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/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"
        }
    ]
}