v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Floors

Retrieve all floors

Retrieve all floors in the space.

Required scopes: flex.space.floors.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

The exact _id of the item you are looking for.

namestring

Example:Fl-01

The exact name of the item you are looking for.

locationstring

Filter by location id.

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

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