# crm.category.list

URL: https://chugunov.pro/api-bitrix24/crm/universal/category/crm-category-list/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список воронок
Scope: `crm`
Кто может выполнять метод: любой пользователь

## Описание

Метод получает список воронок (направлений), которые относятся к типу объекта CRM с идентификатором `entityTypeId`.

**Какие воронки попадут в список**

Список отдаваемых воронок фильтруется по правам доступа. Это значит, что если у пользователя нет прав для чтения определенной воронки, она не попадет в ответ.

## Параметры

- `entityTypeId` `integer` — обязательный. Идентификатор [системного](https://chugunov.pro/api-bitrix24/crm/) или [пользовательского типа](https://chugunov.pro/api-bitrix24/crm/universal/user-defined-object-types/) сущностей CRM, для которого нужно получить список воронок

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "categories": [
            {
                "id": 9,
                "name": "Воронка с оригинальным названием",
                "sort": 200,
                "entityTypeId": 2,
                "isDefault": "N",
                "originId": "",
                "originatorId": ""
            },
            {
                "id": 10,
                "name": "Лидовый маршрут",
                "sort": 200,
                "entityTypeId": 2,
                "isDefault": "N",
                "originId": "",
                "originatorId": ""
            },
            {
                "id": 11,
                "name": "Путь успеха",
                "sort": 200,
                "entityTypeId": 2,
                "isDefault": "N",
                "originId": "",
                "originatorId": ""
            },
            {
                "id": 0,
                "name": "Общая",
                "sort": 300,
                "entityTypeId": 2,
                "isDefault": "Y"
            }
        ]
    },
    "total": 4,
    "time": {
        "start": 1718293410.373042,
        "finish": 1718293425.947633,
        "duration": 15.574590921401978,
        "processing": 15.16909408569336,
        "date_start": "2024-06-13T17:43:30+02:00",
        "date_finish": "2024-06-13T17:43:45+02:00",
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `object`. Корневой элемент ответа. Содержит единственный элемент с ключом `categories`, который представляет собой массив воронок. Структура отдельно взятой воронки соответсвует объекту [`category`](https://chugunov.pro/api-bitrix24/crm/universal/category/crm-category-add/#category)
- `total` `integer`. Общее количество воронок, принадлежащих определенному `entityTypeId`
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "NOT_FOUND",
    "error_description": "Смарт-процесс не найден"
}
```

- `NOT_FOUND` — Смарт-процесс не найден. Возникает, при некорректных значениях `entityTypeId`
- `ENTITY_TYPE_NOT_SUPPORTED` — Entity type `{entityTypeName}` is not supported. Возникает, если объект CRM не поддерживает воронки

## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.list
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.category.list
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type CategoryListResult = {
  categories: Array<{
    id: number
    name: string
    sort: number
    entityTypeId: number
    isDefault: 'Y' | 'N'
    originId?: string
    originatorId?: string
  }>
}

try {
  // crm.category.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<CategoryListResult>({
    method: 'crm.category.list',
    params: {
      entityTypeId: 2,
      start: 0,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Categories:', result.categories, 'Count:', result.categories.length)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function loadCategoryList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // crm.category.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'crm.category.list',
        params: {
          entityTypeId: 2,
          start: 0,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Categories:', result.categories, 'Count:', result.categories.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', loadCategoryList)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.category.list(
        entity_type_id=2,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.category.list',
            [
                'entityTypeId' => 2,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
        echo 'Error: ' . $result->error();
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching category list: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    "crm.category.list",
    {
        entityTypeId: 2,
    },
    (result) => 
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'crm.category.list',
    [
        'entityTypeId' => 2
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.category.list", b24.Params{
	"entityTypeId": 2,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.category.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "categories".
raw, ok := b24.Unwrap(res.Result, "categories")
if !ok {
	return fmt.Errorf("в ответе нет ключа categories")
}

var items []struct {
	ID           b24.ID `json:"id"`
	Name         string `json:"name"`
	Sort         int    `json:"sort"`
	EntityTypeID b24.ID `json:"entityTypeId"`
	IsDefault    string `json:"isDefault"`
	OriginID     string `json:"originId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID)
}
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/crm/universal/category/crm-category-list.html