Skip to main content
GET
/
floors
/
{id}
Search for a floor
curl --request GET \
  --url https://app.planpoint.io/api/floors/{id} \
  --header 'Authorization: <api-key>'
{
  "_id": "<string>",
  "project": "<string>",
  "units": [
    "objectId"
  ],
  "name": "<string>",
  "position": 123,
  "floorplanUrl": "<string>",
  "path": "<string>",
  "alternativePaths": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://viewerdocs.planpoint.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

Floor ID

Example:

"objectId"

Response

Successful operation

​
_id
string<objectId>

Unique identifier for the floor

​
project
string<objectId>

Reference to the associated project

​
units
string<objectId>[]

Reference to associated units

​
name
string

Name of the floor

​
position
integer

Position or order of the floor

​
floorplanUrl
string<uri>

Floorplan image url

​
path
string

Floor drawing path

​
alternativePaths
string[]

Alternative paths for the floor