--- title: "Get all floorplans in project" method: GET path: "/api/v3/projects/{project_id}/floorplans" tags: ["floorplans"] --- # Get all floorplans in project `GET /api/v3/projects/{project_id}/floorplans` ## Path parameters - `project_id` string, uuid, required ## Query parameters - `with_current_sheet` string - `last_synced_at` string, date-time - `filters[tag_eq]` string - `filters[tag_like]` string - `filters[created_at_gte]` string - `filters[created_at_gt]` string - `filters[created_at_lte]` string - `filters[created_at_lt]` string - `filters[name_like]` string - `filters[name_eq]` string - `filters[updated_at_gte]` string - `filters[updated_at_gt]` string - `filters[updated_at_lte]` string - `filters[updated_at_lt]` string ## Headers - `Fieldwire-Version` string, date, required - `Fieldwire-Filter` 'active' | 'deleted' - `Fieldwire-Per-Page` integer ## Response `200` Successful response with Sheets nested - FloorplanWithSheets[] - `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 - `sheets` Sheet[] — Sheets that are part of the Floorplan - `id` string, uuid, required — ID of the entity - `creator_user_id` integer, nullable, required — ID of the user who created this entity - `last_editor_user_id` integer, nullable, required — ID of the user who most recently edited this entity - `user_id` integer, nullable — ID of the user who uploaded this version - `floorplan_id` string, uuid, nullable — ID of the plan this belongs to - `folder_id` string, uuid, nullable — ID of the folder this lives in - `rotate_degrees` integer — Degrees by which the sheet is rotated between 0 to 360 - `project_id` string, uuid, required — ID of the project this entity belongs to - `sheet_upload_id` string, uuid, nullable — ID of the uploaded entity this version was derived from - `has_conflicts` boolean, nullable — Whether this has conflicts with other versions of the plan - `has_errors` boolean, nullable — Whether this has any errors - `has_low_res_tiles` boolean, nullable — Whether this has low resolution tile images - `is_multipage` boolean, required — Whether this was derived out of a PDF with more than 1 page - `is_tiled` boolean, nullable — Whether this carries tiles (rows & columns of images that can be put together to build this) - `android_file_url` string, nullable — URL of the low resolution image of this entity (with a max dimension of 2048 pixels) - `file_name` string, required — Name of the uploaded file out of which this was derived - `file_url` string, nullable — URL of the low resolution image of this entity - `name` string, required — Name of the entity - `name_crop_url` string, nullable — URL of the corner of that carries the name - `original_url` string, nullable — URL of the file that was processed into all the different images in this entity - `suggested_name` string, nullable — Name suggested by our automated text extraction process - `thumb_url` string, nullable — URL of the thumb image of this entity - `tiles_package_url` string, nullable — URL of the zip file that carries all the tile images for this entity - `version_description` string, nullable — Description for this version of the plan - `meters_per_pixel` number, double, nullable — Count of meters each pixel in `file_url` corresponds to - `pdf_height` number, double, nullable — Height of the original PDF file that was processed into this entity - `pdf_width` number, double, nullable — Width of the original PDF file that was processed into this entity - `android_file_height` integer, nullable — Height in pixels of the `android_file_url` image - `android_file_width` integer, nullable — Width in pixels of the `android_file_url` image - `file_height` integer, nullable — Height in pixels of the `file_url` image - `file_width` integer, nullable — Width in pixels of the `file_url` image - `original_height` integer, nullable — Height in pixels of the original image before it was further processed into different dimensions - `original_width` integer, nullable — Height in pixels of the original image before it was further processed into different dimensions - `page_number` integer, nullable — Page number this entity denotes of the uploaded file - `tile_size` integer, nullable — Dimension of each tile image - `tiles_resolution` integer, nullable — Resolution of provided tiles images (in DPI) - `tiles_resolution_type` integer, nullable — Resolution type of tiles images - `version` integer, required — Particular version of the plan this entity denotes - `version_notes` string, nullable — Notes for this version of the plan - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field! - `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 - `text_content_url` string, nullable — Parsed sheet's text content file url --- [API](https://skmtc.dev/fieldwire/apis/fieldwire-super-api.md) · [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-super-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fieldwire/fieldwire-super-api/revisions/66ee1c20b92d/schema)