Get place

Namespace: microsoft.graph

Get the properties and relationships of a place object specified by either its ID or email address.

The 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 that room list.

Both room and roomList are derived from the place object.

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

GET /places/{id}

Optional query parameters

Use $select to get specific place properties.

For more 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 the requested place object in the response body.

Examples

Example 1: Get a room

Request

The following example specifies the id of a room to get its properties.

HTTP

GET https://graph.microsoft.com/v1.0/places/979e9793-3e91-40eb-b18c-0ea937893956

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let place = await client.api('/places/979e9793-3e91-40eb-b18c-0ea937893956')
	.get();

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/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places/$entity",
    "@odata.type": "#microsoft.graph.roomList",
    "id": "979e9793-3e91-40eb-b18c-0ea937893956",
    "displayName": "Building 2 Rooms",
    "address": null,
    "geoCoordinates": null,
    "phone": "",
    "emailAddress": "Building2Rooms@contoso.com"
}

Example 2: Get a room list

Request

The following example specifies the emailAddress of a roomList to get its properties.

HTTP

GET https://graph.microsoft.com/v1.0/places/Building2Rooms@contoso.com

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let place = await client.api('/places/Building2Rooms@contoso.com')
	.get();

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/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places/$entity",
    "@odata.type": "#microsoft.graph.roomList",
    "id": "979e9793-3e91-40eb-b18c-0ea937893956",
    "displayName": "Building 2 Rooms",
    "address": null,
    "geoCoordinates": null,
    "phone": "",
    "emailAddress": "Building2Rooms@contoso.com"
}