Get Fields of the Sales Funnel crm.category.fields

Scope: crm

Who 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 `type`	Description
entityTypeId* `integer`	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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		"crm.category.fields",
        		{
        			entityTypeId: 2,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

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();
        }

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 `type`	Description
result `object`	Object containing a list of available fields in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field_N` is the identifier of the object field, and `value` is an object of type crm_rest_field_description
time `time`	Information about the execution time of the request

Field Descriptions

Name `type`	Description
id `integer`	Identifier of the funnel (direction)
name `string`	Name of the funnel
sort `integer`	Sort index
entityTypeId `integer`	Identifier of the system or user-defined type to which the funnel belongs
isDefault `boolean`	Indicates whether the funnel is the default funnel
originId `string`	Identifier of the data source. Exists only in deals
originatorId `string`	Identifier of the item in the data source. Exists only in deals
isSystem `boolean`	Indicates whether the funnel is a system funnel. Exists only in SPAs
code `string`	Alias for system funnels. Exists only in SPAs

Error Handling

HTTP status: 400

{
            "error": "NOT_FOUND", 
            "error_description": "SPA not found"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`NOT_FOUND`	SPA not found	Occurs with incorrect values for `entityTypeId`
`ENTITY_TYPE_NOT_SUPPORTED`	Entity type `{entityTypeName}` is not supported	Occurs if the CRM entity 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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Delete Funnel

Import

Get Fields of the Sales Funnel crm.category.fields

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Field DescriptionsField Descriptions

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning