FileFolders.List
Return the organization file-folder tree shown on dashboard #filefolder: system folders (Default, Dynamic PDF, Signs, Whatsapp files, Forms, Email files — respecting default_folder_files_settings) plus custom files_folders with nested children. Send scope=filefolder (or folders_only=1) to get folders only. Send parent_id for direct children of one custom folder. Without scope, legacy manager paged files_folders rows are returned in data.
Permissions
- User must be logged in with a valid bearer token.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Returns FileFolders rows as JSON.
- Supports the documented filters and paging fields.
- List responses are capped at 25 rows per call.
Push Service
No push is sent because this function only reads data or returns helper information.
Automation
No automation is run for this function.
Special Instructions
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- Send parameters as POST body fields exactly as documented.
- For paging, do not request more than 25 rows.
- For total rows, call the matching Count function with the same filters.
Required Parameters
No body parameters are required for this function.
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
scopepost | string | filefolder | Send filefolder for the dashboard Files sidebar tree in folders. Alias: mode=filefolder or folders_only=1. |
folders_onlypost | int | 1 | When 1, same as scope=filefolder. |
parent_idpost | int | 42 | When set to a custom folder id, return only that folder's direct children in folders. Alias: data_id. |
limitpost | int | 25 | Page size for legacy files_folders data only. Capped at 25. Ignored for scope=filefolder. |
startpost | int | 0 | Offset for legacy files_folders data rows. |
searchpost | string | Contracts | Search legacy files_folders name columns when not using folders_only. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/FileFolders.List",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"scope": "filefolder"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/FileFolders.List",
"url_domain": "https:\/\/{domain}\/app\/FileFolders.List"
}Endpoint
POST /app/FileFolders.List
POST https://{user}.bull36.com/app/FileFolders.List
POST https://{domain}/app/FileFolders.ListSample Output
{
"success": 1,
"count": 8,
"scope": "filefolder",
"folders": [
{
"id": "default",
"name": "Default",
"is_system": 1,
"parent_id": 0,
"children": []
},
{
"id": 42,
"name": "files folder en",
"is_system": 0,
"parent_id": 0,
"has_children": 1,
"children": [
{
"id": 43,
"name": "new sub folder en 1",
"parent_id": 42,
"children": []
},
{
"id": 44,
"name": "new sub folder en 2",
"parent_id": 42,
"children": []
},
{
"id": 45,
"name": "new sub folder en 3",
"parent_id": 42,
"children": []
}
]
}
]
}Count Only
Use the matching count route with the same filters when the UI only needs total rows for paging.
{
"url": "\/app\/FileFolders.Count",
"url_user": "https:\/\/{user}.bull36.com\/app\/FileFolders.Count",
"url_domain": "https:\/\/{domain}\/app\/FileFolders.Count",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"scope": "filefolder"
},
"sample_output": {
"success": 1,
"count": 123
},
"notes": {
"count": "Use the matching count route when available, or count returned rows.",
"max_limit": 25
}
}Count JavaScript
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('scope', 'filefolder');
const res = await fetch('https://{domain}/app/FileFolders.Count', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data.count);JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ scope: 'filefolder' });
const res = await fetch('/app/FileFolders.List', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data.folders);Error Example
{
"success": 0,
"message": "Permission denied to list files_folders"
}