---
updatedAt: 2026-04-21T05:36:45.000Z
agentTools:
  projectIndex: https://developer.officernd.com/llms.txt
---

# Retrieve all floors

Retrieve all floors in the space. 

 Required scopes: `flex.space.floors.read`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v2/organizations/{orgSlug}/floors": {
      "get": {
        "description": "Retrieve all floors in the space. \n\n Required scopes: `flex.space.floors.read`",
        "operationId": "FloorsController_getItems_api/v2",
        "parameters": [
          {
            "name": "_id",
            "required": false,
            "in": "query",
            "description": "The exact _id of the item you are looking for.",
            "schema": {
              "example": "",
              "type": "string"
            }
          },
          {
            "name": "name",
            "required": false,
            "in": "query",
            "description": "The exact name of the item you are looking for.",
            "schema": {
              "example": "Fl-01",
              "type": "string"
            }
          },
          {
            "name": "location",
            "required": false,
            "in": "query",
            "description": "Filter by location id.",
            "schema": {
              "example": "",
              "type": "string"
            }
          },
          {
            "name": "createdAt",
            "required": false,
            "in": "query",
            "description": "Support date comparison filters: $gt, $gte, $lt, $lte",
            "schema": {
              "example": "createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ",
              "type": "string"
            }
          },
          {
            "name": "modifiedAt",
            "required": false,
            "in": "query",
            "description": "Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte",
            "schema": {
              "example": "modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ",
              "type": "string"
            }
          },
          {
            "name": "$select",
            "required": false,
            "in": "query",
            "description": "Select fields to return",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$cursorNext",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$cursorPrev",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$limit",
            "required": false,
            "in": "query",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "orgSlug",
            "required": true,
            "in": "path",
            "description": "organization slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/PaginatedResultDto"
                    },
                    {
                      "properties": {
                        "results": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/FloorResultDto"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "flex.space.floors.read"
            ]
          }
        ],
        "summary": "Retrieve all floors",
        "tags": [
          "Floors"
        ]
      }
    }
  },
  "info": {
    "title": "Space API",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://app.officernd.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          },
          "authorizationCode": {
            "authorizationUrl": "https://identity.officernd.com/auth/authorize",
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "PaginatedResultDto": {
        "type": "object",
        "properties": {
          "rangeStart": {
            "type": "number"
          },
          "rangeEnd": {
            "type": "number"
          },
          "cursorNext": {
            "type": "string"
          },
          "cursorPrev": {
            "type": "string"
          }
        }
      },
      "FloorResultDto": {
        "type": "object",
        "properties": {
          "_id": {
            "type": "string",
            "description": "The _id of the floor.",
            "example": ""
          },
          "floor": {
            "type": "string",
            "description": "The number of the floor.",
            "example": "1"
          },
          "name": {
            "type": "string",
            "description": "The name of the floor.",
            "example": "Fl-01"
          },
          "location": {
            "type": "string",
            "description": "The _id of the location to which the floor is associated.",
            "example": ""
          },
          "area": {
            "type": "number",
            "description": "The area of the floor in square milimeters (10^6 m^2).",
            "example": 1500000
          },
          "isOpen": {
            "type": "boolean",
            "description": "Shows if the floor is currently open.",
            "example": true
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "description": "The time when the floor was created.",
            "example": "2024-08-21T16:00:00.000Z"
          },
          "modifiedAt": {
            "format": "date-time",
            "type": "string",
            "description": "The time when the floor was last modified.",
            "example": "2024-08-21T16:00:00.000Z"
          }
        }
      }
    }
  }
}
```