Documents.List

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 Documents 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

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Documents.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "url_user": "https:\/\/{user}.bull36.com\/app\/Documents.List",
    "url_domain": "https:\/\/{domain}\/app\/Documents.List"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "count": 150,
    "data": [
        {
            "id": "1001",
            "cust_id": "123",
            "type": "invoice",
            "pdf_url": "https:\/\/..."
        }
    ]
}

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": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Total documents matching the filters.",
        "recordsTotal": "Same total for DataTables clients.",
        "max_limit": 25
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();

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"
}