How to Retrieve a List of Stages with Semantics for CRM Entities

// composer require bitrix24/b24phpsdk:"^3.0"
        require_once 'vendor/autoload.php';
        
        use Bitrix24\SDK\Services\ServiceBuilderFactory;
        use Symfony\Component\EventDispatcher\EventDispatcher;
        use Monolog\Logger;
        use Monolog\Handler\StreamHandler;
        
        $log = new Logger('b24');
        $log->pushHandler(new StreamHandler('php://stdout'));
        
        $sb = (new ServiceBuilderFactory(new EventDispatcher(), $log))
            ->initFromWebhook('https://your-domain.bitrix24.com/rest/USER_ID/TOKEN/');
        
        $statuses = $sb->getCRMScope()->status()->list(
            ['SORT' => 'ASC'], // sort by ascending value in the SORT field
            ['ENTITY_ID' => 'STATUS'] // get stages for leads
        )->getStatuses();
        

from b24pysdk import BitrixWebhook, Client
        
        client = Client(
            BitrixWebhook(
                domain="your-domain.bitrix24.com",
                webhook_token="user_id/webhook_key",
            )
        )
        
        result = client.crm.status.list(
            order={"SORT": "ASC"},  # sort by ascending value in the SORT field
            filter={"ENTITY_ID": "STATUS"},  # get stages for leads
        ).response.result
        

<?php
        // composer require bitrix24/b24phpsdk:"^3.0"
        require_once 'vendor/autoload.php';
        
        use Bitrix24\SDK\Services\ServiceBuilderFactory;
        use Bitrix24\SDK\Services\ServiceBuilder;
        use Symfony\Component\EventDispatcher\EventDispatcher;
        use Monolog\Logger;
        use Monolog\Handler\StreamHandler;
        
        $log = new Logger('b24');
        $log->pushHandler(new StreamHandler('php://stdout'));
        
        $sb = (new ServiceBuilderFactory(new EventDispatcher(), $log))
            ->initFromWebhook('https://your-domain.bitrix24.com/rest/USER_ID/TOKEN/');
        
        // Short semantics to text: there are only three of these values
        const SEMANTICS_MAP = ['S' => 'success', 'F' => 'failure'];
        
        /**
         * Gets all stages for the specified ENTITY_ID
         */
        function loadStatuses(ServiceBuilder $sb, string $entityId): array {
            return $sb->getCRMScope()->status()->list(
                ['SORT' => 'ASC'],
                ['ENTITY_ID' => $entityId]
            )->getStatuses();
        }
        
        /**
         * Returns the stage semantics for any CRM object.
         * EXTRA is present only for leads, deals, and quotes, so for the other
         * objects we convert the short SEMANTICS value into a text one
         */
        function getSemantics($item): string {
            $extra = $item->EXTRA['SEMANTICS'] ?? '';
            if ($extra !== '') {
                return $extra;
            }
            return SEMANTICS_MAP[$item->SEMANTICS] ?? 'process';
        }
        
        /**
         * Groups stages by semantics
         */
        function groupStatusesBySemantics(array $statuses): array {
            $groups = ['success' => [], 'process' => [], 'failure' => []];
        
            foreach ($statuses as $item) {
                $name = $item->NAME ?? $item->STATUS_ID;
                $groups[getSemantics($item)][] = $name;
            }
        
            return $groups;
        }
        
        /**
         * Formats table rows
         */
        function buildTableRows(array $groups): array {
            $max = max(count($groups['success']), count($groups['process']), count($groups['failure']));
        
            $success = array_pad($groups['success'], $max, '');
            $process = array_pad($groups['process'], $max, '');
            $failure = array_pad($groups['failure'], $max, '');
        
            $rows = [];
            for ($i = 0; $i < $max; $i++) {
                $rows[] = [
                    htmlspecialchars($success[$i]),
                    htmlspecialchars($process[$i]),
                    htmlspecialchars($failure[$i])
                ];
            }
            return $rows;
        }
        
        // Leads keep the semantics in EXTRA, the smart process — in SEMANTICS
        $entities = [
            ['title' => 'Lead stages', 'entityId' => 'STATUS'],
            ['title' => 'Smart process stages', 'entityId' => 'DYNAMIC_177_STAGE_7']
        ];
        
        foreach ($entities as $entity) {
            try {
                $statuses = loadStatuses($sb, $entity['entityId']);
                if (empty($statuses)) {
                    echo "<p>No stages for " . htmlspecialchars($entity['title']) . "</p>\n";
                    continue;
                }
        
                $rows = buildTableRows(groupStatusesBySemantics($statuses));
        
                echo "<h2>" . htmlspecialchars($entity['title']) . "</h2>\n";
                echo "<table border=\"1\" style=\"border-collapse: collapse; width: 100%;\">\n";
                echo "<thead><tr>
                    <th style=\"padding: 8px; background: #d4edda;\">Success</th>
                    <th style=\"padding: 8px; background: #fff3cd;\">In progress</th>
                    <th style=\"padding: 8px; background: #f8d7da;\">Failure</th>
                </tr></thead>\n<tbody>";
        
                foreach ($rows as $row) {
                    echo "<tr>
                        <td style=\"padding: 6px;\">{$row[0]}</td>
                        <td style=\"padding: 6px;\">{$row[1]}</td>
                        <td style=\"padding: 6px;\">{$row[2]}</td>
                    </tr>\n";
                }
        
                echo "</tbody></table><br>\n";
        
            } catch (\Throwable $e) {
                echo "<p style=\"color: red;\">Error: " . htmlspecialchars($e->getMessage()) . "</p>\n";
            }
        }
        

from b24pysdk import BitrixWebhook, Client
        from b24pysdk.errors import BitrixAPIError
        
        # Short semantics to text: there are only three of these values
        SEMANTICS_MAP = {"S": "success", "F": "failure"}
        
        def load_statuses(client, entity_id: str) -> list:
            return client.crm.status.list(
                filter={"ENTITY_ID": entity_id},
                order={"SORT": "ASC"},
            ).response.result
        
        def get_semantics(item: dict) -> str:
            """Returns the stage semantics for any CRM object.
        
            EXTRA is present only for leads, deals, and quotes, so for the other
            objects we convert the short SEMANTICS value into a text one.
            """
            extra = (item.get("EXTRA") or {}).get("SEMANTICS")
            if extra:
                return extra
            return SEMANTICS_MAP.get(item.get("SEMANTICS"), "process")
        
        def group_statuses_by_semantics(statuses: list) -> dict:
            groups = {"success": [], "process": [], "failure": []}
            for item in statuses:
                name = item.get("NAME") or item.get("STATUS_ID")
                groups[get_semantics(item)].append(name)
            return groups
        
        def build_table_rows(groups: dict) -> list:
            max_len = max(len(groups["success"]), len(groups["process"]), len(groups["failure"]))
        
            success = groups["success"] + [""] * (max_len - len(groups["success"]))
            process = groups["process"] + [""] * (max_len - len(groups["process"]))
            failure = groups["failure"] + [""] * (max_len - len(groups["failure"]))
        
            return [[success[i], process[i], failure[i]] for i in range(max_len)]
        
        client = Client(
            BitrixWebhook(
                domain="your-domain.bitrix24.com",
                webhook_token="user_id/webhook_key",
            )
        )
        
        # Leads keep the semantics in EXTRA, the smart process — in SEMANTICS
        entities = [
            {"title": "Lead stages", "entity_id": "STATUS"},
            {"title": "Smart process stages", "entity_id": "DYNAMIC_177_STAGE_7"},
        ]
        
        for entity in entities:
            try:
                statuses = load_statuses(client, entity["entity_id"])
            except BitrixAPIError as error:
                print(f"Loading error: {error}")
                continue
        
            if not statuses:
                print(f"No stages for {entity['title']}")
                continue
        
            print(entity["title"])
            print("Success\tIn progress\tFailure")
            for row in build_table_rows(group_statuses_by_semantics(statuses)):
                print("\t".join(row))