Get Folder

GET 
/folder/:folder_id

The Get Folder API allows you to retrieve details about a specific folder.

Request

Path Parameters

folder_id stringrequired

objectId of folder

Responses

200

successful operation

application/json

Schema

Schema

objectId string
folderName string
parentFolderId objectId
parentFolderName objectId
createdAt date
updatedAt date

Example (from schema)

{
  "objectId": "ph1bhx2jp",
  "folderName": "new folder",
  "parentFolderId": "J2nas5kiPe",
  "parentFolderName": "new sub folder",
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}

400

Something went wrong, please try again later!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Something went wrong, please try again later!"
}

404

folder not found.

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "folder not found."
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Invalid API token!"
}

Loading...