user: findRooms

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

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.

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

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.
Content-Type string application/json. Required.

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 emailAddress objects in the response body.

Example

Request 1

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

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

Here is an example of the response.

Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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.onmicrosoft.com"
        },
        {
            "name": "Conf Room Baker",
            "address": "Baker@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Crystal",
            "address": "Crystal@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Hood",
            "address": "Hood@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Rainier",
            "address": "Rainier@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Stevens",
            "address": "Stevens@contoso.onmicrosoft.com"
        }
    ]
}
Request 2

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

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

Here is an example of the response.

Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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.onmicrosoft.com"
        },
        {
            "name": "Conf Room Hood",
            "address": "Hood@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Rainier",
            "address": "Rainier@contoso.onmicrosoft.com"
        }
    ]
}