Get Folder Details

This endpoint retrieves the details of a specific folder identified by its unique folderId.

Request Parameters

• folderId (path parameter): The unique identifier of the folder you want to retrieve. This should be a valid ID corresponding to an existing folder in the system.

Response

The response will contain a JSON object with the following structure:

• status: A string indicating the status of the request.

• data: An object containing detailed information about the folder:

• _id: The unique identifier of the folder.

• companyId: The ID of the company associated with the folder.

• userId: The ID of the user who owns the folder.

• folderType: The type of folder.

• name: The name of the folder.

• description: A brief description of the folder.

• defaultAssignTo: The default user assigned to the folder (can be null).

• showOrder: An integer indicating the order in which the folder is displayed.

• userShowOrder: An object mapping user IDs to their specific display order for the folder.

• isDeleted: A boolean indicating whether the folder has been deleted.

• folderId: The ID of the folder.

• createdAt: The timestamp when the folder was created.

• updatedAt: The timestamp when the folder was last updated.

• __v: The version key for the document.

• source: An object containing:

• type: The type of source associated with the folder.

• subCategory: The subcategory of the source.

• shared: An array containing information about users or entities with whom the folder is shared.

Notes

• Ensure that the folderId provided in the request is valid, as an invalid ID will result in an error response.

• The isDeleted field in the response indicates whether the folder is currently active or has been marked for deletion.