Get Folder By Path

Retrieves the folder for the provided folder path. If provided folder path is not found returns 404. The following query params are supported

• path - Full path of the folder including all parent folders. The path should start with the root folder.
• complete - Returns detailed response when complete parameter is set true. By default it is false and minimal response will be returned.
• status - To retrieve soft deleted folder, set status attribute as deleted. Hard deleted folder cannot be retrieved.

Prerequisites

• A folder should be created. To know more about creating a folder refer here

Request

GET {baseUrl}/spaces/{spaceId}/folders?path=/My_folder

• Headers:

  • Authorization: Bearer {tid token}

Response

Example Response:

{
  "createdAt": "2023-05-30T10:30:00Z",
  "createdByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
  "updatedAt": "2023-05-30T10:30:00Z",
  "updatedByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
  "deleted": false,
  "id": "f85bc802-5481-4581-b972-c4652d595ec7",
  "name": "My_folder",
  "type": "FOLDER",
  "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
  "version": "1"
}

To know more about the Get folder by path API refer here.