v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

folders

Create a new folder

post/api/v3/projects/{project_id}/folders

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Request body

idstring uuid

ID of the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

namestring required

Name of the entity

kind'floorplan' | 'attachment' | 'bim'

Kind of the entity

required_role'follower' | 'member' | 'admin'

User role required to view the files belonging to this folder

device_created_atstring date-time

Time when the device created the entity

device_updated_atstring date-time

Time when the device last updated the entity

folder_idstring uuid nullable

ID of the folder containing this folder

deleted_by_two_way_syncboolean nullable

Indicates if a file was deleted by two way sync

Response

Successful response

idstring uuid required

ID of the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

project_idstring uuid required

ID of the project this entity belongs to

namestring required

Name of the entity

cascade_deleted_dependents_countinteger nullable

Count of entities this folder cascade deleted

cascade_deleted_by_idboolean 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_conflictboolean nullable required

Specifies if PUT/PATCH request was rejected - do not store this field!

created_atstring date-time required

Time when the server created the entity

deleted_atstring date-time nullable

Time the server deleted the entity

device_created_atstring date-time required

Time when the device created the entity

device_updated_atstring date-time required

Time when the device last updated the entity

updated_atstring date-time required

Time when the server last updated the entity

folder_idstring uuid nullable

ID of the folder containing this folder

collection_idstring uuid nullable

ID of the collection folder, root-level folder parent

deleted_by_two_way_syncboolean nullable required

Indicates if a file was deleted by two way sync