POST

Products.List

Return products configured for the account, with filters, paging, and a maximum page size of 25. Optional active filter maps to ec_product.status: active=1 returns only active products, active=0 returns only inactive products. When active is omitted, both active and inactive products are returned. Product Type filter (type): product, subscription, service, or donation (same as dashboard Type dropdown; not a separate list API).

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

  • Product type filter (type) allowed values: product (Physical Product), subscription, service, donation.
  • Omit type to return all product types.
  • suppliers_id on each product is an array of string ids (dashboard multi-select / check_json), e.g. ["267"]. Empty or legacy 0 becomes [].

Required Parameters

No body parameters are required for this function.

Optional Parameters

NameTypeSampleWhat it gives
search
post
stringmembershipFilters by product name, description, or SKU.
type
post
stringproductFilter by Product Type (dashboard Type column). Allowed values: product (Physical Product), subscription, service, donation. Omit to return all types.
active
post
int1Optional active filter: 1 = active products only, 0 = inactive products only. When omitted, returns both active and inactive products.
cat_id
post
int4Filters by product category id when used by the account. Alias: category.
sub_cat_id
post
int8Filters by product sub-category id when used by the account.
limit
post
int25Limits returned products. Values above 25 are capped.
offset
post
int0Skips records for paging.
order
post
stringid_descOrders rows. Supported values include id_desc, id_asc, date_desc, date_asc.
start
post
int0First row offset for paging.
length
post
int25Maximum number of rows to return. Values above 25 are capped to 25.
per_page
post
int25Alternative page-size field. Values above 25 are capped to 25.
draw
post
int1Optional DataTables draw counter.
search[value]
post
stringjohnDataTables search text when supported.
filter_data
post
stringjohnLegacy/general filter text when supported.
from_date
post
date2026-07-01Filters rows from this date when the list supports date filtering. Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
to_date
post
date2026-07-17Filters rows until this date when the list supports date filtering. Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
date_field
post
stringdate_createdDate column selector when supported, such as date_created, last_updated, updated, or followup.
created_from
post
date2026-07-01Filters rows created from this date when supported. Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
created_to
post
date2026-07-17Filters rows created until this date when supported. Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
updated_from
post
date2026-07-01Filters rows updated from this date when supported. Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
updated_to
post
date2026-07-17Filters rows updated until this date when supported. Send date filters and date values as UTC Y-m-d H:i:s when the route accepts date/time; date-only table columns store the Y-m-d date part.
order_by
post
stringdate_createdColumn/key to order by when supported.
sort
post
stringdate_descSort preset when supported.
order_dir
post
stringdescOrder direction: asc or desc.
order[0][column]
post
int0DataTables column index to order by when supported.
order[0][dir]
post
stringdescDataTables order direction: asc or desc.
folder_id
post
mixed1Folder filter when the list supports folders.
folder
post
mixed1,2One or more folder ids/names when the list supports folders.
status_id
post
mixed1Status filter when the list supports statuses.
tag
post
mixed1Tag filter when the list supports tags.
tag_id
post
mixed1Tag id filter when the list supports tags.
source
post
mixedwebsiteSource filter when the list supports source values.
team_member_id
post
mixed47Team member/assignee filter when supported.
stock
post
mixed10Stock filter when supported.
custom_field
post
stringvip_levelCustom field name for list filtering when supported.
custom_field_value
post
mixedgoldCustom field value paired with custom_field when supported.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Products.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "limit": "25",
        "active": "1"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Products.List",
    "url_domain": "https:\/\/{domain}\/app\/Products.List"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "data": [
        {
            "id": "123",
            "product_name": "Membership"
        }
    ],
    "limit": 25,
    "offset": 0
}

Count Only

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

{
    "url": "\/app\/Products.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Products.Count",
    "url_domain": "https:\/\/{domain}\/app\/Products.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "active": "1"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "route": "Products.Count",
        "max_limit": 25
    }
}

Count JavaScript

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

const res = await fetch('https://{domain}/app/Products.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/Products.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"
}