Commands › Inventory
inventory_folder_contents
A folder's contents as JSON
Usage
curl -X POST "https://api.lifebots.cloud/api/bot.html" \
-H "Content-Type: application/json" \
-d '{
"action": "inventory_folder_contents",
"apikey": "YOUR_API_KEY",
"botname": "Joe Resident",
"secret": "bot-secret-123",
"folderId": "7c1e9b2a-4d3f-4a8b-9c6d-000000000000",
"dataType": "json"
}' Every request also needs apikey, botname and secret — see Authentication.
Parameters
| Name | Required | Description |
|---|---|---|
folderIdUUID | yes | Folder UUID. Also accepted as: folderUuid |
includeSubfoldersflag | no | 0 to leave sub-folders out of the list. Default: 1 |
Example response
{
"result": "OK",
"items": [
{
"id": "7c1e9b2a-4d3f-4a8b-9c6d-000000000000",
"name": "Gifts",
"type": "Folder",
"folderType": -1
},
{
"id": "5d2d7a1d-0e8e-4f5d-a678-000000000000",
"name": "Welcome",
"type": "Notecard",
"folderType": -1
}
]
} With dataType=json. A failure has result: "FAIL" and the reason in resulttext — see Responses & errors.
Good to know
- Direct contents only.