get_root_folders
List root folders in a Carbon Voice workspace, including names, IDs, and structure, for voicememo or prerecorded message types. Supports sorting and optional folder tree inclusion.
Instructions
Lists all root folders for a given workspace, including their names, IDs, and basic structure, but does not provide aggregate counts.(Required to inform message type:voicememo,prerecorded)
Input Schema
Name | Required | Description | Default |
---|---|---|---|
include_all_tree | No | Return all folders tree | |
sort_by | No | Field to sort by | name |
sort_direction | No | Sort order direction | ASC |
type | Yes | Folder Type | |
workspace_id | No | Workspace ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"include_all_tree": {
"description": "Return all folders tree",
"type": "boolean"
},
"sort_by": {
"default": "name",
"description": "Field to sort by",
"enum": [
"created_at",
"last_updated_at",
"name"
],
"type": "string"
},
"sort_direction": {
"default": "ASC",
"description": "Sort order direction",
"enum": [
"ASC",
"DESC"
],
"type": "string"
},
"type": {
"description": "Folder Type",
"enum": [
"voicememo",
"prerecorded"
],
"type": "string"
},
"workspace_id": {
"description": "Workspace ID",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}