Files.List
List client_file rows for the logged-in organization, matching the dashboard Files page (#filefolder): thumb type, name, client name, and date. Omit customer_id for the org-wide file manager. Send customer_id to list one customer only (legacy). Filter with folder/type (default, dynamic_pdf, sign, whatsapp_files, forms, email_files, custom folder id, or all). Search notes/file name. Page size is capped at 25.
Permissions
- User must be logged in with a valid bearer token.
- The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
- Returned or changed records are limited by the user permissions, team access, folder access, and account settings.
Action
- Returns Files 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.
- On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
- 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 |
|---|---|---|---|
customer_idpost | int | 123 | Optional. When set, only files for this customer (same visibility rules as Customer.Get). Aliases: cust_id, clientid. |
folderpost | string | default | Folder/type filter like the dashboard folder tabs. Use default, dynamic_pdf, sign, whatsapp_files, forms, email_files, a custom files_folders id, or all/def_all for every visible folder. Aliases: type, active_folder, folder_id. |
typepost | string | default | Alias for folder (dashboard POST type). |
sub_typepost | string | 12 | Optional sub-folder id. When set, filters client_file.type to this value (dashboard sub_type). |
searchpost | string | contract | Search notes and file path. Aliases: text, name_search, filter_data, search[value]. |
page_idpost | int | 1 | 1-based page. Org-wide default page size is 10 (dashboard). Alias: page. |
startpost | int | 0 | Row offset. Ignored when page_id is set. |
limitpost | int | 25 | Page size, capped at 25. Aliases: length, per_page. |
include_folderspost | int | 1 | When 1, always include the folders sidebar array. Org-wide lists already include folders by default. |
Authentication
Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/Files.List",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"folder": "default",
"page_id": "1",
"limit": "10"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Files.List",
"url_domain": "https:\/\/{domain}\/app\/Files.List"
}Endpoint
POST /app/Files.List
POST https://{user}.bull36.com/app/Files.List
POST https://{domain}/app/Files.ListSample Output
{
"success": 1,
"count": 1,
"recordsTotal": 42,
"page_id": 1,
"start": 0,
"limit": 10,
"folder": "default",
"search": "",
"folders": [
{
"id": "default",
"key": "default",
"name": "default",
"is_system": 1
}
],
"data": [
{
"id": 650406,
"file_id_hex": "9ec26",
"customer_id": 13455191,
"client_name": "nidhi",
"display_name": "14-4ac275951787130965.png",
"file_url": "https:\/\/files.biz1.co.il\/biz1upload\/upload\/files\/...",
"folder": "default",
"thumb_type": "image",
"create_date": "2026-08-19 10:00:00",
"date": "19.08.2026"
}
]
}Count Only
Use the matching count route with the same filters when the UI only needs total rows for paging.
{
"url": "\/app\/Files.Count",
"url_user": "https:\/\/{user}.bull36.com\/app\/Files.Count",
"url_domain": "https:\/\/{domain}\/app\/Files.Count",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"folder": "default"
},
"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('folder', 'default');
const res = await fetch('https://{domain}/app/Files.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({ folder: 'default', page_id: '1', limit: '10' });
const res = await fetch('/app/Files.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data.data);Error Example
{
"success": 0,
"message": "Customer not found"
}