POST

Statuses.List

Return all_status rows for the logged-in account. Use type to filter (ticket, internal_status, customer_status, sources, internal_sub_status). Default type=all returns every bucket. For the settings Customer Statuses modal use CustomerStatuses.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 Statuses 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

  • Customer Statuses settings screen: POST /app/CustomerStatuses.List (not Statuses.List).
  • Folder internal statuses: POST /app/Statuses.List with type=internal_status and folder_id=<folder id>. Response data[] rows are all_status where type=internal_status and folder_id matches.
  • Ticket statuses: type=ticket. Folder customer status options: type=customer_status and folder_id.
  • Sub-statuses under an internal status: type=internal_sub_status (filter by patent_status_id on rows; optional folder_id).
  • Customer profile Orders List statuses: type=order_status (or use Order.Statuses).

Required Parameters

No body parameters are required for this function.

Optional Parameters

NameTypeSampleWhat it gives
type
post
stringinternal_statusall_status bucket. Default all. Values: ticket, internal_status, customer_status, sources, internal_sub_status, order_status, all.
folder_id
post
int3Filter by folder for folder-linked status types.
search
post
stringWaitingSearch name_en, name_he, and type.
start
post
int0First row offset for paging. Alias: offset.
limit
post
int25Maximum rows to return. Values above 25 are capped. Aliases: length, per_page.

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Statuses.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "type": "internal_status",
        "folder_id": "3",
        "limit": "25"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Statuses.List",
    "url_domain": "https:\/\/{domain}\/app\/Statuses.List"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "count": 2,
    "type": "internal_status",
    "source": "all_status",
    "data": [
        {
            "id": 124,
            "status_id": 124,
            "name_en": "Waiting For Docs",
            "type": "internal_status",
            "folder_id": 3
        }
    ]
}

Count Only

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

{
    "url": "\/app\/Statuses.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Statuses.Count",
    "url_domain": "https:\/\/{domain}\/app\/Statuses.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "type": "internal_status",
        "folder_id": "3"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "route": "Statuses.Count"
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('type', 'internal_status');
body.set('folder_id', '3');

const res = await fetch('https://{domain}/app/Statuses.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({ type: 'internal_status', folder_id: '3', limit: '25' });
const res = await fetch('/app/Statuses.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data.count, data.data);

Error Example

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