---
title: "Get floorplan by ID"
method: GET
path: "/api/v3/projects/{project_id}/floorplans/{id}"
tags: ["floorplans"]
---

# Get floorplan by ID

`GET /api/v3/projects/{project_id}/floorplans/{id}`

## Request

- Base URL: `https://client-api.us.fieldwire.com`
- URL: `https://client-api.us.fieldwire.com/api/v3/projects/{project_id}/floorplans/{id}`
- Auth: HTTP bearer

## Path parameters

- `project_id` string, uuid, required
- `id` string, uuid, required

## Headers

- `Fieldwire-Version` string, date, required

## Response `200`

Successful response

- Floorplan: Floorplan Entity schema
  - `id` string, uuid, required: ID of the entity
  - `creator_user_id` integer, required: ID of the user who created this entity
  - `last_editor_user_id` integer, required: ID of the user who most recently edited this entity
  - `cascade_deleted_by_id` string, uuid, nullable: ID of the item that cascaded its delete to this entity
  - `folder_id` string, uuid, nullable: Entity ID of the Folder the Floorplan is in.
  - `project_id` string, uuid, required: ID of the project this entity belongs to
  - `is_name_confirmed` boolean, required: When false indicates that User needs to confirm the Floorplan name after auto-naming it from OCR.
  - `is_ocr_processing` boolean, required: Floorplan has been run through OCR processing
  - `is_user_confirmed` boolean, required: When false indicates the Floorplan name is in conflict. i.e same as an existing Floorplan on the Project.
  - `description` string, nullable: A short description of the entity
  - `name` string, required: Name of the entity
  - `resolved_conflict` boolean, required: Specifies if PUT/PATCH request was rejected - do not store this field!
  - `active_sheets_count` integer, nullable: Number of active sheets in this Floorplan
  - `process_state` 'deleting' | 'restoring' | 'null', nullable: A string indicating the state of the Floorplan.
  - `created_at` string, date-time, required: Time when the server created the entity
  - `deleted_at` string, date-time, nullable: Time the server deleted the entity
  - `device_created_at` string, date-time, required: Time when the device created the entity
  - `device_updated_at` string, date-time, required: Time when the device last updated the entity
  - `updated_at` string, date-time, required: Time when the server last updated the entity
  - `latest_component_device_updated_at` string, date-time, nullable: Time when a device last updated a markup on the plan
  - `deleted_by_two_way_sync` boolean, nullable, required: Indicates if a file was deleted by two way sync
  - `is_marked_for_capture` boolean, required: Indicates if a floorplan is marked for field capture

---

[API](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api.md) - [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/revisions/34b820438c0b?raw)