POST

Messages.List

Return a paged list of message records visible to the logged-in user.

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

Name	Type	Sample	What it gives
`customer_id` post	int	`123`	Filter messages for one customer.
`limit` post	int	`25`	Maximum rows to return; capped at 25.
`start` post	int	`0`	Paging offset.
`read` post	int	`0`	Filter unread/read messages.
`trash` post	int	`0`	0 returns active messages; 1 returns trash.
`search` post	string	`invoice`	Search subject, body, or email.
`length` post	int	`25`	Maximum number of rows to return. Values above 25 are capped to 25.
`per_page` post	int	`25`	Alternative page-size field. Values above 25 are capped to 25.
`draw` post	int	`1`	Optional DataTables draw counter.
`search[value]` post	string	`john`	DataTables search text when supported.
`filter_data` post	string	`john`	Legacy/general filter text when supported.
`from_date` post	date	`2026-07-01`	Filters 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	date	`2026-07-17`	Filters 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	string	`date_created`	Date column selector when supported, such as date_created, last_updated, updated, or followup.
`created_from` post	date	`2026-07-01`	Filters 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	date	`2026-07-17`	Filters 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	date	`2026-07-01`	Filters 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	date	`2026-07-17`	Filters 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	string	`date_created`	Column/key to order by when supported.
`sort` post	string	`date_desc`	Sort preset when supported.
`order_dir` post	string	`desc`	Order direction: asc or desc.
`order[0][column]` post	int	`0`	DataTables column index to order by when supported.
`order[0][dir]` post	string	`desc`	DataTables order direction: asc or desc.
`folder_id` post	mixed	`1`	Folder filter when the list supports folders.
`folder` post	mixed	`1,2`	One or more folder ids/names when the list supports folders.
`status_id` post	mixed	`1`	Status filter when the list supports statuses.
`tag` post	mixed	`1`	Tag filter when the list supports tags.
`tag_id` post	mixed	`1`	Tag id filter when the list supports tags.
`source` post	mixed	`website`	Source filter when the list supports source values.
`team_member_id` post	mixed	`47`	Team member/assignee filter when supported.
`custom_field` post	string	`vip_level`	Custom field name for list filtering when supported.
`custom_field_value` post	mixed	`gold`	Custom 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\/Messages.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Messages.List",
    "url_domain": "https:\/\/{domain}\/app\/Messages.List"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "count": 1,
    "data": [
        {
            "message_id": "101",
            "customer_id": "123",
            "subject": "Follow up"
        }
    ]
}

Count Only

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

{
    "url": "\/app\/Messages.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Messages.Count",
    "url_domain": "https:\/\/{domain}\/app\/Messages.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Use Messages.Count with the same filters to get only the total."
    }
}

Count JavaScript

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

const res = await fetch('https://{domain}/app/Messages.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({ limit: '25' });
const res = await fetch('/app/Messages.List', { method: 'POST', headers: { Authorization: `Bearer ${token}` }, body });
const data = await res.json();

Error Example

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