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

# Get folder by ID

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

## Path parameters

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

## Headers

- `Fieldwire-Version` string, date, required

## Response `200`

Successful response

- Folder — Entity used for grouping plans/files etc.
  - `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
  - `project_id` string, uuid, required — ID of the project this entity belongs to
  - `name` string, required — Name of the entity
  - `cascade_deleted_dependents_count` integer, nullable — Count of entities this folder cascade deleted
  - `cascade_deleted_by_id` boolean, nullable — Cascade deleted by id
  - `kind` 'floorplan' | 'attachment' | 'bim', required — Kind of the entity
  - `process_state` 'deleting' | 'restoring' | 'null', nullable — State of deletion of this folder
  - `required_role` 'follower' | 'member' | 'admin', required — User role required to view the files belonging to this folder
  - `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
  - `folder_id` string, uuid, nullable — ID of the folder containing this folder
  - `collection_id` string, uuid, nullable — ID of the collection folder, root-level folder parent
  - `deleted_by_two_way_sync` boolean, nullable, required — Indicates if a file was deleted by two way sync
  - `integration_metadata` object, nullable, required — Contains integration metadata, if the file is linked to a File automation
    - `id` string, uuid, required — ID of the remote_app_item
    - `entity_id` string, uuid, required — ID of the folder, which own these metadata
    - `name` string, required — Name of the integration app
    - `logo_filename` string — Name of the logo file to display as the folder's icon
    - `status` 'starting' | 'stopped' | 'started' | 'error', required — Status of the automation

---

[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)
