POST

Chat.Inbox

Return the internal chat inbox for the logged-in account.

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.Inbox 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
`page` post	int	`1`	Page number.
`per_page` post	int	`25`	Number of conversations per page. You may also send limit. Values above 25 are capped to 25.
`sort` post	string	`last_update_desc`	Optional caller-side sort hint; default backend order is newest updated conversation 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.
`limit` post	int	`25`	Maximum number of rows to return. 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.Inbox",
    "method": "POST",
    "body": {
        "page": "1",
        "per_page": "25"
    },
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Chat.Inbox",
    "url_domain": "https:\/\/{domain}\/app\/Chat.Inbox"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "page": 1,
    "data": [
        {
            "id": 3283713,
            "customer_id": 123,
            "message": "Hello",
            "created_at": "2026-07-20 10:17:00"
        }
    ]
}

Count Only

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

{
    "url": "\/app\/Chat.Inbox",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Chat.Inbox",
    "url_domain": "https:\/\/{domain}\/app\/Chat.Inbox",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Number of conversations in the returned page.",
        "total": "Total conversations when returned.",
        "total_pages": "Pages available at this page size."
    }
}

Count JavaScript

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

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