List places

Article
07/22/2024

Namespace: microsoft.graph

Get a collection of the specified type of place objects defined in the tenant. For example, you can get all the rooms, all the room lists, or the rooms in a specific room list in the tenant.

A place object can be one of the following types:

A room which includes rich properties such as an email address for the room, and accessibility, capacity, and device support.
A room list which includes an email address for the room list, and a navigation property to get the collection of room instances in the room list.

Both room and roomList are derived from the place object.

By default, this operation returns 100 places per page.

Compared with the findRooms and findRoomLists functions, this operation returns a richer payload for rooms and room lists. See details for how they compare.

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

HTTP request

To get all the rooms in a tenant:

GET /places/microsoft.graph.room

To get all the room lists in a tenant:

GET /places/microsoft.graph.roomlist

To get all the rooms in the specified room list:

GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/rooms

Optional query parameters

This method supports the following query parameters to help customize the response:

$filter
$select
$top
$skip
$count=true

Use $top to customize the page size. The default page size is 100.

For general information, see OData query parameters.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

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

Examples

Example 1: List all the rooms defined in the tenant

Request

The following example shows how to get all the room objects in the tenant.

GET https://graph.microsoft.com/v1.0/places/microsoft.graph.room


// 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.Places.GraphRoom.GetAsync();



mgc places graph-room get



// Code snippets are only available for the latest major version. Current major version is $v1.*

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


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


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RoomCollectionResponse result = graphClient.places().graphRoom().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let room = await client.api('/places/microsoft.graph.room')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->places()->graphRoom()->get()->wait();


Import-Module Microsoft.Graph.Calendar

Get-MgPlaceAsRoom


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph 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.places.graph_room.get()

Response

The following example shows the response.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places/microsoft.graph.room",
  "value": [
    {
      "id": "3162F1E1-C4C0-604B-51D8-91DA78989EB1",
      "emailAddress": "[email protected]",
      "displayName": "Conf Room 100",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geoCoordinates": {
        "latitude": 47.640568390488626,
        "longitude": -122.1293731033803
      },
      "phone": "000-000-0000",
      "nickname": "Conf Room",
      "label": "100",
      "capacity": 50,
      "building": "1",
      "floorNumber": 1,
      "isManaged": true,
      "isWheelChairAccessible": false,
      "bookingType": "standard",
      "tags": [
        "bean bags"
      ],
      "audioDeviceName": null,
      "videoDeviceName": null,
      "displayDevice": "surface hub"
    },
    {
      "id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
      "emailAddress": "[email protected]",
      "displayName": "Conf Room 200",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geoCoordinates": {
        "latitude": 47.640568390488625,
        "longitude": -122.1293731033802
      },
      "phone": "000-000-0000",
      "nickname": "Conf Room",
      "label": "200",
      "capacity": 40,
      "building": "2",
      "floorNumber": 2,
      "isManaged": true,
      "isWheelChairAccessible": false,
      "bookingType": "standard",
      "tags": [
        "benches",
        "nice view"
      ],
      "audioDeviceName": null,
      "videoDeviceName": null,
      "displayDevice": "surface hub"
    }
  ]
}

Example 2: List all the room lists defined in the tenant

Request

The following example shows how to get all the roomList objects in the tenant.

GET https://graph.microsoft.com/v1.0/places/microsoft.graph.roomlist


// 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.Places.GraphRoomList.GetAsync();



mgc places graph-room-list get



// Code snippets are only available for the latest major version. Current major version is $v1.*

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


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


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RoomListCollectionResponse result = graphClient.places().graphRoomList().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let roomlist = await client.api('/places/microsoft.graph.roomlist')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->places()->graphRoomList()->get()->wait();


Import-Module Microsoft.Graph.Calendar

Get-MgPlaceAsRoomList


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph 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.places.graph_room_list.get()

Response

The following example shows the response.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places/microsoft.graph.roomList",
  "value": [
    {
      "id": "DC404124-302A-92AA-F98D-7B4DEB0C1705",
      "displayName": "Building 1",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geocoordinates": null,
      "phone": null,
      "emailAddress": "[email protected]"
    },
    {
      "id": "DC404124-302A-92AA-F98D-7B4DEB0C1706",
      "displayName": "Building 2",
      "address": {
        "street": "4567 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "postalCode": "98052",
        "countryOrRegion": "USA"
      },
      "geocoordinates": null,
      "phone": null,
      "emailAddress": "[email protected]"
    }
  ]
}

Example 3: List rooms contained in a room list

Request

The following example shows how to get a list of room objects contained in a roomList.

GET https://graph.microsoft.com/v1.0/places/[email protected]/microsoft.graph.roomlist/rooms


// 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.Places["{place-id}"].GraphRoomList.Rooms.GetAsync();



mgc places graph-room-list-by-id rooms list --place-id {place-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
rooms, err := graphClient.Places().ByPlaceId("place-id").GraphRoomList().Rooms().Get(context.Background(), nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

RoomCollectionResponse result = graphClient.places().byPlaceId("{place-id}").graphRoomList().rooms().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let rooms = await client.api('/places/[email protected]/microsoft.graph.roomlist/rooms')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->places()->byPlaceId('place-id')->graphRoomList()->rooms()->get()->wait();


Import-Module Microsoft.Graph.Calendar

Get-MgPlaceAsRoomListRoom -PlaceId $placeId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph 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.places.by_place_id('place-id').graph_room_list.rooms.get()

Response

The following example shows the response.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places('Building2Rooms%40contoso.com')/microsoft.graph.roomList/rooms",
    "value": [
        {
            "id": "f4119db7-9a33-4bfe-a387-4444b9e7fd54",
            "displayName": "Conf Room Rainier",
            "address": null,
            "geoCoordinates": null,
            "phone": "",
            "nickname": "Conf Room Rainier",
            "emailAddress": "[email protected]",
            "building": null,
            "floorNumber": null,
            "floorLabel": null,
            "label": null,
            "capacity": null,
            "bookingType": "standard",
            "audioDeviceName": null,
            "videoDeviceName": null,
            "displayDeviceName": null,
            "isWheelChairAccessible": false,
            "tags": []
        },
        {
            "id": "42385a28-1a16-4043-8d84-07615656c4e3",
            "displayName": "Conf Room Hood",
            "address": null,
            "geoCoordinates": null,
            "phone": "",
            "nickname": "Conf Room Hood",
            "emailAddress": "[email protected]",
            "building": null,
            "floorNumber": null,
            "floorLabel": null,
            "label": null,
            "capacity": null,
            "bookingType": "standard",
            "audioDeviceName": null,
            "videoDeviceName": null,
            "displayDeviceName": null,
            "isWheelChairAccessible": false,
            "tags": []
        },
        {
            "id": "850ee91e-a154-4d87-928e-da04c788fd90",
            "displayName": "Conf Room Baker",
            "address": null,
            "geoCoordinates": null,
            "phone": "",
            "nickname": "Conf Room Baker",
            "emailAddress": "[email protected]",
            "building": null,
            "floorNumber": null,
            "floorLabel": null,
            "label": null,
            "capacity": null,
            "bookingType": "standard",
            "audioDeviceName": null,
            "videoDeviceName": null,
            "displayDeviceName": null,
            "isWheelChairAccessible": false,
            "tags": []
        }
    ]
}

Share via

List places

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Example 1: List all the rooms defined in the tenant

Request

Response

Example 2: List all the room lists defined in the tenant

Request

Response

Example 3: List rooms contained in a room list

Request

Response

Feedback

Additional resources