POST

DocumentStatuses.List

List document_status rows for the logged-in account. Same data as Settings → Document Status modal table (ID, English name, Hebrew name, color), ordered by status_order ASC.

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

Use DocumentStatuses.* for the Document Status settings popup. Statuses.* is all_status. CustomerStatuses.* is customer folder statuses.
These statuses are used on documents.user_status (e.g. purchase orders / proposals). Filter documents with Documents.List user_status / status_id.
Owner or member-admin only (settings manager).

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`type_for` post	string	`purchase_orders`	Optional. Dashboard default type_for is purchase_orders. Omit or send all for every type. Aliases: document_status_type, type.
`search` post	string	`Shipped`	Search name_en, name_he, type_for.
`start` post	int	`0`	Paging offset.
`limit` post	int	`25`	Page size (max 25).

Authentication

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

Authorization: Bearer YOUR TOKEN

Sample Request

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

Endpoint

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

Sample Output

{
    "success": 1,
    "count": 3,
    "source": "document_status",
    "data": [
        {
            "id": 3453,
            "name_en": "In Production",
            "name_he": "In Production",
            "color": "#c48bb8",
            "type_for": "purchase_orders",
            "status_order": 1
        },
        {
            "id": 3454,
            "name_en": "Shipped",
            "name_he": "Shipped",
            "color": "#2e8b57",
            "type_for": "purchase_orders",
            "status_order": 2
        }
    ]
}

Count Only

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

{
    "url": "\/app\/DocumentStatuses.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/DocumentStatuses.Count",
    "url_domain": "https:\/\/{domain}\/app\/DocumentStatuses.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Use the matching count route when available, or count returned rows.",
        "max_limit": 25
    }
}

Count JavaScript

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

const res = await fetch('https://{domain}/app/DocumentStatuses.Count', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const res = await fetch('/app/DocumentStatuses.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body: new URLSearchParams({ limit: '25' }) });
console.log(await res.json());

Error Example

{
    "success": 0,
    "message": "permission denied"
}