Get Fields of the Sales Funnel crm.category.fields
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
crmWho can execute the method: any user
The method retrieves information about the fields of the sales funnels (directions) of the CRM object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the system or user-defined type of CRM objects for which to retrieve information about the funnel fields |
Code Examples
How to Use Examples in Documentation
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.fields
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.fields
// 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
type FieldDescription = {
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
isDynamic: boolean
title: string
upperName: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type CategoryFieldsResult = {
fields: Record<string, FieldDescription>
}
try {
const response = await $b24.actions.v2.call.make<CategoryFieldsResult>({
method: 'crm.category.fields',
params: {
entityTypeId: 2,
},
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('Available category fields:', Object.keys(result.fields))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 getCategoryFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.category.fields',
params: {
entityTypeId: 2,
},
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('Available category fields:', Object.keys(result.fields))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCategoryFields)
</script>
try {
$response = $b24Service
->core
->call(
'crm.category.fields',
[
'entityTypeId' => 2,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling crm.category.fields: ' . $e->getMessage();
}
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.category.fields(
entity_type_id=2,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
BX24.callMethod(
"crm.category.fields",
{
entityTypeId: 2,
},
(result) => {
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.category.fields',
[
'entityTypeId' => 2
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"fields": {
"id": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID",
"upperName": "ID"
},
"name": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "NAME",
"upperName": "NAME"
},
"sort": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "SORT",
"upperName": "SORT"
},
"entityTypeId": {
"type": "integer",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ENTITY_TYPE_ID",
"upperName": "ENTITY_TYPE_ID"
},
"isDefault": {
"type": "boolean",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "IS_DEFAULT",
"upperName": "IS_DEFAULT"
},
"originId": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ORIGIN_ID",
"upperName": "ORIGIN_ID"
},
"originatorId": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ORIGINATOR_ID",
"upperName": "ORIGINATOR_ID"
}
}
},
"time": {
"start": 1718098629.350263,
"finish": 1718098629.800741,
"duration": 0.45047783851623535,
"processing": 0.02919292449951172,
"date_start": "2024-06-11T11:37:09+02:00",
"date_finish": "2024-06-11T11:37:09+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing a list of available fields in the format |
|
time |
Information about the execution time of the request |
Field Descriptions
|
Name |
Description |
|
id |
Identifier of the funnel (direction) |
|
name |
Name of the funnel |
|
sort |
Sort index |
|
entityTypeId |
Identifier of the system or user-defined type to which the funnel belongs |
|
isDefault |
Indicates whether the funnel is the default funnel |
|
originId |
Identifier of the data source. Exists only in deals |
|
originatorId |
Identifier of the item in the data source. Exists only in deals |
|
isSystem |
Indicates whether the funnel is a system funnel. Exists only in SPAs |
|
code |
Alias for system funnels. Exists only in SPAs |
Error Handling
HTTP status: 400
{
"error": "NOT_FOUND",
"error_description": "SPA not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
SPA not found |
Occurs with incorrect values for |
|
|
Entity type |
Occurs if the CRM object does not support funnels |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |