Edit

Share via

place: descendants

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 all the descendants of a specific type under a place.

Note: This method can't return more than 2,500 places.

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}/descendants/{placeType}

Note: {placeType} can be any supported place type such as microsoft.graph.building, microsoft.graph.floor, microsoft.graph.section, microsoft.graph.room, microsoft.graph.workspace, and microsoft.graph.desk.

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 function returns a 200 OK response code and a place collection in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/places/ca163ae1-14a3-4e2a-8a97-5f82d672186f/descendants/microsoft.graph.desk

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

{
  "value": [
    {
      "id": "530f7900-8063-4daf-9cc1-168cb3ac26e9",
      "placeId": "530f7900-8063-4daf-9cc1-168cb3ac26e9",
      "displayName": "desk 5",
      "parentId": "ca163ae1-14a3-4e2a-8a97-5f82d672186f",
      "isWheelChairAccessible": false,
      "mode": {
        "@odata.type": "#microsoft.graph.offlinePlaceMode",
        "reason": "New"
      }
    },
    {
      "id": "57289959-4add-4270-872b-cc93ca099ce5",
      "placeId": "57289959-4add-4270-872b-cc93ca099ce5",
      "displayName": "desk 6",
      "parentId": "ca163ae1-14a3-4e2a-8a97-5f82d672186f",
      "isWheelChairAccessible": true,
      "mailboxDetails": {
        "externalDirectoryObjectId": "6abaaee5-b796-48d0-be3d-0aa980258321",
        "emailAddress": "desk54a4fce541749088182888@contoso.com"
      },
      "mode": {
        "@odata.type": "#microsoft.graph.reservablePlaceMode"
      }
    }
  ]
}