Customer.ListOptions

Permissions

• User must be logged in. Returned options follow account settings.

Action

• Returns available list options the UI can show for customer filters.

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

• Use these options only for customer list/filter UI.

Required Parameters

No body parameters are required for this function.

Optional Parameters

No optional body parameters are defined for this function.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

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

Endpoint

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

Sample Output

{
    "html": "List option 1 List option 2"
}

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.ListOptions",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Customer.ListOptions",
    "url_domain": "https:\/\/{domain}\/app\/Customer.ListOptions",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "options_count": "Count option items in the returned html\/text.",
        "max_limit": "No paging field on this option list."
    }
}

Count JavaScript

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

const res = await fetch('https://{domain}/app/Customer.ListOptions', {
  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();

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

Error Example

{
    "success": "0",
    "message": "Request failed"
}