POST

Chat.EmailList

Return customer email/message rows with inbox, outbox, unread, paging, and search filters.

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

Runs the Chat.EmailList function and returns JSON.

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.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`data_type` post	string	`inbox`	Filter: inbox, outbox, not_read, or other supported message folder.
`page_id` post	int	`1`	Page number.
`search_text` post	string	`invoice`	Search by message subject.
`limit` post	int	`25`	Optional caller-side max. Values above 25 are capped; backend returns 15 per page.
`sort` post	string	`id_desc`	Optional caller-side sort hint; default backend order is newest message id first.
`start` post	int	`0`	First row offset for paging.
`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` post	string	`john`	Search text for list routes when supported.
`search[value]` post	string	`john`	DataTables search text when supported.
`filter_data` post	string	`john`	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.
`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\/Chat.EmailList",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "url_user": "https:\/\/{user}.bull36.com\/app\/Chat.EmailList",
    "url_domain": "https:\/\/{domain}\/app\/Chat.EmailList"
}

Endpoint

POST /app/Chat.EmailList
POST https://{user}.bull36.com/app/Chat.EmailList
POST https://{domain}/app/Chat.EmailList

Sample Output

{
    "output": "Message rows text",
    "totalrecords": 15
}

Count Only

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

{
    "url": "\/app\/Chat.EmailList",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Chat.EmailList",
    "url_domain": "https:\/\/{domain}\/app\/Chat.EmailList",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "totalrecords": "Number of message rows returned in this page.",
        "clientemail_paggination_div": "Pagination HTML\/text when available.",
        "max_limit": 25
    }
}

Count JavaScript

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

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

Error Example

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