Customer.List

Permissions

• User sees only customers allowed by account permissions, team access, folder access, and sharing rules.

Action

• Returns customer rows with filters and paging.
• Caps page size to 25.
• Returns total/count fields when available.

Push Service

No push is sent because this is a read method.

Automation

No automation is run because this is a read method.

Special Instructions

• For total rows, call Customer.Count with the same filters.
• Keep length, limit, or per_page at 25 or less.

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\/Customer.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "start": "0",
        "length": "25",
        "folder_id": "1"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.List",
    "url_domain": "https:\/\/{domain}\/app\/Customer.List"
}

Endpoint

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

Sample Output

{
    "success": "1",
    "recordsTotal": 25,
    "recordsFiltered": 25,
    "data": [
        {
            "id": "123",
            "customer_id": "123",
            "name": "John Demo",
            "mobile": "0500000000",
            "email": "[email protected]"
        }
    ]
}

Fail Response

{
    "success": 0,
    "message": "Bearer token is required"
}

Count Only

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

{
    "url": "\/app\/Customer.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Count",
    "url_domain": "https:\/\/{domain}\/app\/Customer.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "folder_id": "1"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "recordsTotal": "Total customers before filtering when returned.",
        "recordsFiltered": "Total customers after filtering when returned.",
        "data_count": "Use count(data) when only rows are returned."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('folder_id', '1');

const res = await fetch('https://{domain}/app/Customer.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({
  start: '0',
  length: '25',
  folder_id: '1'
});

const res = await fetch('/app/Customer.List', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});

const data = await res.json();
console.log(data);

Error Example

{
    "success": "0",
    "error": "bearer_token_required",
    "message": "Authorization bearer token is required. Send header: Authorization: Bearer YOUR TOKEN"
}