Documents.Count

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 only the count for Documents using the same filters as the list function.

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.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Documents.Count",
    "body": {
        "customer_id": "123",
        "default_value_folder": "all"
    },
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Documents.Count",
    "url_domain": "https:\/\/{domain}\/app\/Documents.Count"
}

Endpoint

POST /app/Documents.Count
POST https://{user}.bull36.com/app/Documents.Count
POST https://{domain}/app/Documents.Count

Sample Output

{
    "success": 1,
    "count": 12
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/Documents.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Documents.Count",
    "url_domain": "https:\/\/{domain}\/app\/Documents.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "customer_id": "123",
        "default_value_folder": "all"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Total documents\/files matching the sent customer and folder filters."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('customer_id', '123');
body.set('default_value_folder', 'all');

const res = await fetch('https://{domain}/app/Documents.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();
// Fill body fields from the Sample Request JSON above.
const res = await fetch('/app/Documents.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

{
    "success": 0,
    "message": "permission denied"
}