Microsoft Graph Places is an API surface in Microsoft Graph that lets applications discover and work with physical location resources in Microsoft 365—primarily meeting rooms and room lists (and, in some tenants, workspaces). It provides a tenant-wide, directory-backed catalog of places that apps can list and query, returning rich metadata such as name, address, coordinates, building and floor details, email address, and capacity.
openapi: 3.1.0
info:
title: Microsoft Graph Places
description: Needs a description.
paths:
/places:
description: Provides operations to manage the collection of place entities.
post:
tags:
- Places.place
summary: Microsoft Graph Create place
description: >-
Create a new place object. You can also use this method to create the
following child object types: building, floor, section, room, workspace,
or desk.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-post?view=graph-rest-1.0
operationId: places.place.CreatePlace
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/places/{place-id}:
description: Provides operations to manage the collection of place entities.
patch:
tags:
- Places.place
summary: Microsoft Graph Update place
description: >-
Update the properties of place object that can be a building, floor,
section, desk, room, workspace, or roomList. You can identify the place
by specifying the id property.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-update?view=graph-rest-1.0
operationId: places.place.UpdatePlace
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.place'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Places.place
summary: Microsoft Graph Delete place
description: >-
Delete a place object. You can also use this method to delete the
following child object types: building, floor, section, or desk.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-delete?view=graph-rest-1.0
operationId: places.place.DeletePlace
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
/places/{place-id}/checkIns:
description: >-
Provides operations to manage the checkIns property of the
microsoft.graph.place entity.
get:
tags:
- places.checkInClaim
summary: Microsoft Graph Get checkInClaim
description: >-
Read the properties and relationships of a checkInClaim object. This API
provides the check-in status for a specific place, such as a desk, room,
or workspace, associated with a particular reservation.
operationId: places.ListCheckIns
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.checkInClaimCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.checkInClaim
summary: Microsoft Graph Create checkInClaim
description: >-
Create a new checkInClaim object to record the check-in status for a
specific place, such as a desk or a room, associated with a specific
calendar reservation. This check-in confirms that the reserved space is
in use and prevents automatic release if auto-release policies are
configured for that place.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/place-post-checkins?view=graph-rest-1.0
operationId: places.CreateCheckIns
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
x-ms-docs-grouped-path:
- /places/{place-id}/graph.building/checkIns
- /places/{place-id}/graph.desk/checkIns
- /places/{place-id}/graph.floor/checkIns
- /places/{place-id}/graph.room/checkIns
- /places/{place-id}/graph.roomList/checkIns
- /places/{place-id}/graph.roomList/rooms/{room-id}/checkIns
- /places/{place-id}/graph.roomList/workspaces/{workspace-id}/checkIns
- /places/{place-id}/graph.section/checkIns
- /places/{place-id}/graph.workspace/checkIns
/places/{place-id}/checkIns/{checkInClaim-calendarEventId}:
description: >-
Provides operations to manage the checkIns property of the
microsoft.graph.place entity.
get:
tags:
- places.checkInClaim
summary: Microsoft Graph Get checkInClaim
description: >-
Read the properties and relationships of a checkInClaim object. This API
provides the check-in status for a specific place, such as a desk, room,
or workspace, associated with a particular reservation.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/checkinclaim-get?view=graph-rest-1.0
operationId: places.GetCheckIns
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.checkInClaim
summary: Microsoft Graph Update the navigation property checkIns in places
operationId: places.UpdateCheckIns
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.checkInClaim
summary: Microsoft Graph Delete navigation property checkIns for places
operationId: places.DeleteCheckIns
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
- name: checkInClaim-calendarEventId
in: path
description: The unique identifier of checkInClaim
required: true
schema:
type: string
x-ms-docs-key-type: checkInClaim
x-ms-docs-grouped-path:
- >-
/places/{place-id}/graph.building/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.desk/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.floor/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.room/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.roomList/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.roomList/rooms/{room-id}/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.roomList/workspaces/{workspace-id}/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.section/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.workspace/checkIns/{checkInClaim-calendarEventId}
/places/{place-id}/checkIns/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- places.checkInClaim
summary: Microsoft Graph Get the number of the resource
operationId: places.checkIns.GetCount-2709
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
/places/{place-id}/graph.building:
description: Casts the previous resource to building.
get:
tags:
- Places.place
summary: Microsoft Graph List place objects
description: "Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:\r\n- List all buildings.\r\n- List all floors.\r\n- List all sections.\r\n- List all desks.\r\n- List all rooms.\r\n- List all workspaces.\r\n- List all room lists.\r\n- List rooms in a specific room list.\r\n- List workspaces in a specific room list."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/place-list?view=graph-rest-1.0
operationId: places.place.GetPlace.AsBuilding
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.building'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
/places/{place-id}/graph.building/checkIns:
description: >-
Provides operations to manage the checkIns property of the
microsoft.graph.place entity.
get:
tags:
- places.checkInClaim
summary: Microsoft Graph Get checkIns from places
description: >-
A subresource of a place object that indicates the check-in status of an
Outlook calendar event booked at the place.
operationId: places.AsBuilding.ListCheckIns
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.checkInClaimCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.checkInClaim
summary: Microsoft Graph Create new navigation property to checkIns for places
operationId: places.AsBuilding.CreateCheckIns
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
x-ms-docs-grouped-path:
- /places/{place-id}/checkIns
- /places/{place-id}/graph.desk/checkIns
- /places/{place-id}/graph.floor/checkIns
- /places/{place-id}/graph.room/checkIns
- /places/{place-id}/graph.roomList/checkIns
- /places/{place-id}/graph.roomList/rooms/{room-id}/checkIns
- /places/{place-id}/graph.roomList/workspaces/{workspace-id}/checkIns
- /places/{place-id}/graph.section/checkIns
- /places/{place-id}/graph.workspace/checkIns
/places/{place-id}/graph.building/checkIns/{checkInClaim-calendarEventId}:
description: >-
Provides operations to manage the checkIns property of the
microsoft.graph.place entity.
get:
tags:
- places.checkInClaim
summary: Microsoft Graph Get checkIns from places
description: >-
A subresource of a place object that indicates the check-in status of an
Outlook calendar event booked at the place.
operationId: places.AsBuilding.GetCheckIns
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.checkInClaim
summary: Microsoft Graph Update the navigation property checkIns in places
operationId: places.AsBuilding.UpdateCheckIns
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.checkInClaim'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.checkInClaim
summary: Microsoft Graph Delete navigation property checkIns for places
operationId: places.AsBuilding.DeleteCheckIns
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
- name: checkInClaim-calendarEventId
in: path
description: The unique identifier of checkInClaim
required: true
schema:
type: string
x-ms-docs-key-type: checkInClaim
x-ms-docs-grouped-path:
- /places/{place-id}/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.desk/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.floor/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.room/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.roomList/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.roomList/rooms/{room-id}/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.roomList/workspaces/{workspace-id}/checkIns/{checkInClaim-calendarEventId}
- /places/{place-id}/graph.section/checkIns/{checkInClaim-calendarEventId}
- >-
/places/{place-id}/graph.workspace/checkIns/{checkInClaim-calendarEventId}
/places/{place-id}/graph.building/checkIns/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- places.checkInClaim
summary: Microsoft Graph Get the number of the resource
operationId: places.AsBuilding.checkIns.GetCount-114f
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
/places/{place-id}/graph.building/map:
description: >-
Provides operations to manage the map property of the
microsoft.graph.building entity.
get:
tags:
- places.buildingMap
summary: Microsoft Graph Get buildingMap
description: Get the map of a building in IMDF format.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/buildingmap-get?view=graph-rest-1.0
operationId: places.AsBuilding.GetMap
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.buildingMap'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Microsoft Graph Update the navigation property map in places
operationId: places.AsBuilding.UpdateMap
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.buildingMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.buildingMap'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Microsoft Graph Delete buildingMap
description: Delete the map of a specific building.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/buildingmap-delete?view=graph-rest-1.0
operationId: places.AsBuilding.DeleteMap
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
/places/{place-id}/graph.building/map/footprints:
description: >-
Provides operations to manage the footprints property of the
microsoft.graph.buildingMap entity.
get:
tags:
- places.buildingMap
summary: Microsoft Graph List footprints
description: >-
Get a list of footprintMap objects for building footprints and their
properties.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/buildingmap-list-footprints?view=graph-rest-1.0
operationId: places.AsBuilding.map.ListFootprints
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.footprintMapCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- places.buildingMap
summary: Microsoft Graph Create new navigation property to footprints for places
operationId: places.AsBuilding.map.CreateFootprints
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
/places/{place-id}/graph.building/map/footprints/{footprintMap-id}:
description: >-
Provides operations to manage the footprints property of the
microsoft.graph.buildingMap entity.
get:
tags:
- places.buildingMap
summary: Microsoft Graph Get footprints from places
description: >-
Represents the approximate physical extent of a referenced building. It
corresponds to footprint.geojson in IMDF format.
operationId: places.AsBuilding.map.GetFootprints
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- places.buildingMap
summary: Microsoft Graph Update the navigation property footprints in places
operationId: places.AsBuilding.map.UpdateFootprints
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.footprintMap'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- places.buildingMap
summary: Microsoft Graph Delete navigation property footprints for places
operationId: places.AsBuilding.map.DeleteFootprints
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: place-id
in: path
description: The unique identifier of place
required: true
schema:
type: string
x-ms-docs-key-type: place
- name: footprintMap-id
in: path
description: The unique identifier of footprintMap
required: true
schema:
type: string
x-ms-docs-key-type: footprintMap
/places/{place-id}/graph.building/map/footprints/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- places.buildingMap
summary: Microsoft Graph Get the number of the resource
operationId: places.AsBuilding.map.footprints.GetCount-273d
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: place-id
in: path
description: The unique identifier of place
require
# --- truncated at 32 KB (194 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/places-openapi-original.yml