POST
Emails.Count
Return only the number of email/message rows matching the same filters used by Emails.List.
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 only the count for Emails using the same filters as the list function.
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_typepost | string | inbox | Chooses the message folder, such as inbox, outbox, not_read, or another supported folder. |
page_idpost | int | 1 | Chooses which result page to return. |
search_textpost | string | invoice | Filters email/message rows by subject or searchable text. |
limitpost | int | 25 | Limits returned rows. Values above 25 are capped. |
sortpost | string | id_desc | Sort hint for clients; default output is newest messages first. |
startpost | int | 0 | First row offset for paging. |
lengthpost | int | 25 | Maximum number of rows to return. Values above 25 are capped to 25. |
per_pagepost | int | 25 | Alternative page-size field. Values above 25 are capped to 25. |
drawpost | int | 1 | Optional DataTables draw counter. |
searchpost | string | john | Search text for list routes when supported. |
search[value]post | string | john | DataTables search text when supported. |
filter_datapost | string | john | Legacy/general filter text when supported. |
from_datepost | 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_datepost | 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_fieldpost | string | date_created | Date column selector when supported, such as date_created, last_updated, updated, or followup. |
created_frompost | 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_topost | 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_frompost | 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_topost | 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_bypost | string | date_created | Column/key to order by when supported. |
order_dirpost | 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_idpost | mixed | 1 | Folder filter when the list supports folders. |
folderpost | mixed | 1,2 | One or more folder ids/names when the list supports folders. |
status_idpost | mixed | 1 | Status filter when the list supports statuses. |
tagpost | mixed | 1 | Tag filter when the list supports tags. |
tag_idpost | mixed | 1 | Tag id filter when the list supports tags. |
sourcepost | mixed | website | Source filter when the list supports source values. |
team_member_idpost | mixed | 47 | Team member/assignee filter when supported. |
custom_fieldpost | string | vip_level | Custom field name for list filtering when supported. |
custom_field_valuepost | 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\/Emails.Count",
"method": "POST",
"body": {
"data_type": "inbox",
"search_text": "invoice"
},
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Emails.Count",
"url_domain": "https:\/\/{domain}\/app\/Emails.Count"
}Endpoint
POST /app/Emails.Count
POST https://{user}.bull36.com/app/Emails.Count
POST https://{domain}/app/Emails.CountSample Output
{
"success": 1,
"count": 15
}Count Only
Use the matching count route with the same filters when the UI only needs total rows for paging.
{
"url": "\/app\/Emails.Count",
"url_user": "https:\/\/{user}.bull36.com\/app\/Emails.Count",
"url_domain": "https:\/\/{domain}\/app\/Emails.Count",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"data_type": "inbox",
"search_text": "invoice"
},
"sample_output": {
"success": 1,
"count": 123
},
"notes": {
"count": "Total email\/message rows matching the sent filters."
}
}Count JavaScript
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('data_type', 'inbox');
body.set('search_text', 'invoice');
const res = await fetch('https://{domain}/app/Emails.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/Emails.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"
}