get_folder
Retrieve a folder by its ID on Carbon Voice. Optionally include the first level of the folder tree and filter subfolders by update date in either newer or older direction.
Instructions
Get a folder by its ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Return only Subfolders updated based on the date and direction (must inform include_first_level_tree = true) | |
| direction | No | Direction of the results (newer or older) | newer |
| id | Yes | ||
| include_first_level_tree | No | Defines if the first level of the folder tree should be returned |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"date": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Return only Subfolders updated based on the date and direction (must inform include_first_level_tree = true)"
},
"direction": {
"default": "newer",
"description": "Direction of the results (newer or older)",
"enum": [
"older",
"newer"
],
"type": "string"
},
"id": {
"type": "string"
},
"include_first_level_tree": {
"description": "Defines if the first level of the folder tree should be returned",
"type": "boolean"
}
},
"required": [
"id"
],
"type": "object"
}