Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Floors

Gets a specific floor

Get the floor with id = {floorId}.

Required scopes: flex.space.floors.read

get/api/v2/organizations/{orgSlug}/floors/{floorId}

Path parameters

floorIdstring required

The id of the corresponding floor

orgSlugstring required

organization slug

Response

_idstring

The _id of the floor.

floorstring

The number of the floor.

namestring

The name of the floor.

locationstring

The _id of the location to which the floor is associated.

areanumber

The area of the floor in square milimeters (10^6 m^2).

isOpenboolean

Shows if the floor is currently open.

createdAtstring date-time

The time when the floor was created.

modifiedAtstring date-time

The time when the floor was last modified.

Example response

{
  "floor": "1",
  "name": "Fl-01",
  "area": 1500000,
  "isOpen": true,
  "createdAt": "2024-08-21T16:00:00.000Z",
  "modifiedAt": "2024-08-21T16:00:00.000Z"
}