Get a list of custom types crm.type.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: any user with administrative access to the CRM section

This method retrieves a list of smart process settings.

Method Parameters

Name
type

Description

order
object

Object format: { field_1: value_1, field_2: value_2, ..., field_n: value_n }, where

  • field_n: the name of the field by which the smart processes will be sorted
  • value_n: a string value, equal to:
    • ASC — ascending order
    • DESC — descending order

Possible values for field correspond to the fields of the type object

filter
object

Object format: { field_1: value_1, field_2: value_2, ..., field_n: value_n }, where

  • field_n: the name of the field by which the smart processes will be filtered
  • value_n: the filter value

Possible values for field correspond to the fields of the type object

The filter can have unlimited nesting and number of conditions.
By default, all conditions are combined with each other as AND. If you need to use OR, you can pass a special key logic with the value OR.

You can add a prefix to the field_n keys to clarify the filter's operation.
Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • !% — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides
  • !=% — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searches for values not starting with "mol"
    • "%mol" — searches for values not ending with "mol"
    • "%mol%" — searches for values where the substring "mol" is not present in any position
  • !%= — NOT LIKE (similar to !=%)
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

start
integer

This parameter is used for pagination control.

The page size of results is always static — 50 records.

To select the second page of results, pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the number of the desired page

Required parameters are marked with *

Examples

How to Use Examples in Documentation

  1. Get a list of all smart processes where title contains either 5 or 0. Sort the resulting list in descending order by id.

    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[{"logic":"OR",{"%title":"5"},{"%title":"0"}]},"order":{"id":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.list
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":[{"logic":"OR",{"%title":"5"},{"%title":"0"}]},"order":{"id":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.type.list
        
    // 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CrmTypeItem = {
          id: number
          title: string
          code: string
          createdBy: number
          entityTypeId: number
          customSectionId: number | null
          isCategoriesEnabled: string
          isStagesEnabled: string
          isBeginCloseDatesEnabled: string
          isClientEnabled: string
          isUseInUserfieldEnabled: string
          isLinkWithProductsEnabled: string
          isMycompanyEnabled: string
          isDocumentsEnabled: string
          isSourceEnabled: string
          isObserversEnabled: string
          isRecyclebinEnabled: string
          isAutomationEnabled: string
          isBizProcEnabled: string
          isSetOpenPermissions: string
          isPaymentsEnabled: string
          isCountersEnabled: string
          createdTime: ISODate
          updatedTime: ISODate
          updatedBy: number
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CrmTypeListResult = {
          types: CrmTypeItem[]
        }
        
        try {
          // crm.type.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<CrmTypeListResult>({
            method: 'crm.type.list',
            params: {
              filter: {
                '0': {
                  logic: 'OR',
                  '0': {
                    '%title': '5',
                  },
                  '1': {
                    '%title': '0',
                  },
                },
              },
              order: {
                id: 'DESC',
              },
              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('Smart process types:', result.types, 'Page size:', result.types.length)
          }
        } 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 listCrmTypes() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // crm.type.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.type.list',
                params: {
                  filter: {
                    '0': {
                      logic: 'OR',
                      '0': {
                        '%title': '5',
                      },
                      '1': {
                        '%title': '0',
                      },
                    },
                  },
                  order: {
                    id: 'DESC',
                  },
                  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('Smart process types:', result.types, 'Page size:', result.types.length)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listCrmTypes)
        </script>
        
    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.list(
                filter={
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isCategoriesEnabled": "Y",
                    "isClientEnabled": "Y",
                },
            ).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}")

    Example as_list

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.list(
                filter={
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isCategoriesEnabled": "Y",
                    "isClientEnabled": "Y",
                },
                order={
                    "id": "ASC",
                },
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        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}")

    Example as_list_fast

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.list(
                filter={
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isCategoriesEnabled": "Y",
                    "isClientEnabled": "Y",
                },
                order={
                    "id": "ASC",
                },
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        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}")
        
    require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.list',
            [
                'filter' => [
                    [
                        'logic' => 'OR',
                        [
                            '%title' => '5',
                        ],
                        [
                            '%title' => '0',
                        ],
                    ],
                ],
                'order' => [
                    'id' => 'DESC',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

  2. Get a list of smart processes where:

    • Automation rules and triggers are enabled (isAutomationEnabled)
    • Business process designer is enabled (isBizProcEnabled)
    • Custom sales funnels and tunnels are enabled (isCategoriesEnabled)
    • Custom stages and Kanban are enabled (isClientEnabled)
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"isAutomationEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.list
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"isAutomationEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.type.list
        
    // 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, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CrmTypeItem = {
          id: number
          title: string
          code: string
          createdBy: number
          entityTypeId: number
          customSectionId: number | null
          isCategoriesEnabled: string
          isStagesEnabled: string
          isBeginCloseDatesEnabled: string
          isClientEnabled: string
          isUseInUserfieldEnabled: string
          isLinkWithProductsEnabled: string
          isMycompanyEnabled: string
          isDocumentsEnabled: string
          isSourceEnabled: string
          isObserversEnabled: string
          isRecyclebinEnabled: string
          isAutomationEnabled: string
          isBizProcEnabled: string
          isSetOpenPermissions: string
          isPaymentsEnabled: string
          isCountersEnabled: string
          createdTime: ISODate
          updatedTime: ISODate
          updatedBy: number
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CrmTypeListResult = {
          types: CrmTypeItem[]
        }
        
        try {
          // crm.type.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<CrmTypeListResult>({
            method: 'crm.type.list',
            params: {
              filter: {
                isAutomationEnabled: 'Y',
                isBizProcEnabled: 'Y',
                isCategoriesEnabled: 'Y',
                isClientEnabled: 'Y',
              },
              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('Smart process types:', result.types, 'Page size:', result.types.length)
          }
        } 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 listCrmTypes() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // crm.type.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.type.list',
                params: {
                  filter: {
                    isAutomationEnabled: 'Y',
                    isBizProcEnabled: 'Y',
                    isCategoriesEnabled: 'Y',
                    isClientEnabled: 'Y',
                  },
                  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('Smart process types:', result.types, 'Page size:', result.types.length)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listCrmTypes)
        </script>
        
    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.list(
                filter={
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isCategoriesEnabled": "Y",
                    "isClientEnabled": "Y",
                },
            ).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}")

    Example as_list

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.list(
                filter={
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isCategoriesEnabled": "Y",
                    "isClientEnabled": "Y",
                },
            ).as_list().response
            result = bitrix_response.result
            for item in result:
                print(item)
        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}")

    Example as_list_fast

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.type.list(
                filter={
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isCategoriesEnabled": "Y",
                    "isClientEnabled": "Y",
                },
            ).as_list_fast(descending=True).response
            result = bitrix_response.result
            for item in result:
                print(item)
        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}")
        
    require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.list',
            [
                'filter' => [
                    'isAutomationEnabled' => 'Y',
                    'isBizProcEnabled' => 'Y',
                    'isCategoriesEnabled' => 'Y',
                    'isClientEnabled' => 'Y',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
    // client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.type.list", b24.Params{
        	"filter": b24.Params{
        		"isAutomationEnabled": "Y",
        		"isBizProcEnabled":    "Y",
        		"isCategoriesEnabled": "Y",
        		"isClientEnabled":     "Y",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.type.list: %w", err)
        }
        
        // The method wraps the response in an object with the "types" key.
        raw, ok := b24.Unwrap(res.Result, "types")
        if !ok {
        	return fmt.Errorf("no types key in the response")
        }
        
        var items []struct {
        	ID                  b24.ID `json:"id"`
        	Title               string `json:"title"`
        	Code                string `json:"code"`
        	CreatedBy           int    `json:"createdBy"`
        	EntityTypeID        b24.ID `json:"entityTypeId"`
        	IsCategoriesEnabled string `json:"isCategoriesEnabled"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.ID)
        }

Response Handling

HTTP status: 200

{
            "result": {
                "types": [
                    {
                        "id": 37,
                        "title": "Smart Process #20",
                        "code": "",
                        "createdBy": 1,
                        "entityTypeId": 1256,
                        "customSectionId": null,
                        "isCategoriesEnabled": "Y",
                        "isStagesEnabled": "N",
                        "isBeginCloseDatesEnabled": "Y",
                        "isClientEnabled": "Y",
                        "isUseInUserfieldEnabled": "Y",
                        "isLinkWithProductsEnabled": "N",
                        "isMycompanyEnabled": "Y",
                        "isDocumentsEnabled": "Y",
                        "isSourceEnabled": "Y",
                        "isObserversEnabled": "Y",
                        "isRecyclebinEnabled": "Y",
                        "isAutomationEnabled": "Y",
                        "isBizProcEnabled": "N",
                        "isSetOpenPermissions": "N",
                        "isPaymentsEnabled": "N",
                        "isCountersEnabled": "N",
                        "createdTime": "2024-07-08T17:24:55+02:00",
                        "updatedTime": "2024-07-08T17:24:55+02:00",
                        "updatedBy": 1
                    },
                    {
                        "id": 32,
                        "title": "Smart Process #15",
                        "code": "",
                        "createdBy": 1,
                        "entityTypeId": 1246,
                        "customSectionId": null,
                        "isCategoriesEnabled": "N",
                        "isStagesEnabled": "Y",
                        "isBeginCloseDatesEnabled": "N",
                        "isClientEnabled": "Y",
                        "isUseInUserfieldEnabled": "Y",
                        "isLinkWithProductsEnabled": "Y",
                        "isMycompanyEnabled": "N",
                        "isDocumentsEnabled": "N",
                        "isSourceEnabled": "N",
                        "isObserversEnabled": "N",
                        "isRecyclebinEnabled": "N",
                        "isAutomationEnabled": "N",
                        "isBizProcEnabled": "Y",
                        "isSetOpenPermissions": "Y",
                        "isPaymentsEnabled": "N",
                        "isCountersEnabled": "N",
                        "createdTime": "2024-07-08T17:24:52+02:00",
                        "updatedTime": "2024-07-08T17:24:52+02:00",
                        "updatedBy": 1
                    },
                    {
                        "id": 27,
                        "title": "Smart Process #10",
                        "code": "",
                        "createdBy": 1,
                        "entityTypeId": 1236,
                        "customSectionId": null,
                        "isCategoriesEnabled": "N",
                        "isStagesEnabled": "Y",
                        "isBeginCloseDatesEnabled": "Y",
                        "isClientEnabled": "Y",
                        "isUseInUserfieldEnabled": "N",
                        "isLinkWithProductsEnabled": "N",
                        "isMycompanyEnabled": "Y",
                        "isDocumentsEnabled": "N",
                        "isSourceEnabled": "Y",
                        "isObserversEnabled": "N",
                        "isRecyclebinEnabled": "N",
                        "isAutomationEnabled": "Y",
                        "isBizProcEnabled": "Y",
                        "isSetOpenPermissions": "Y",
                        "isPaymentsEnabled": "N",
                        "isCountersEnabled": "N",
                        "createdTime": "2024-07-08T17:24:50+02:00",
                        "updatedTime": "2024-07-08T17:24:50+02:00",
                        "updatedBy": 1
                    },
                    {
                        "id": 22,
                        "title": "Smart Process #5",
                        "code": "",
                        "createdBy": 1,
                        "entityTypeId": 1226,
                        "customSectionId": null,
                        "isCategoriesEnabled": "Y",
                        "isStagesEnabled": "N",
                        "isBeginCloseDatesEnabled": "N",
                        "isClientEnabled": "N",
                        "isUseInUserfieldEnabled": "Y",
                        "isLinkWithProductsEnabled": "Y",
                        "isMycompanyEnabled": "N",
                        "isDocumentsEnabled": "N",
                        "isSourceEnabled": "Y",
                        "isObserversEnabled": "Y",
                        "isRecyclebinEnabled": "Y",
                        "isAutomationEnabled": "N",
                        "isBizProcEnabled": "Y",
                        "isSetOpenPermissions": "Y",
                        "isPaymentsEnabled": "N",
                        "isCountersEnabled": "N",
                        "createdTime": "2024-07-08T17:24:48+02:00",
                        "updatedTime": "2024-07-08T17:24:48+02:00",
                        "updatedBy": 1
                    }
                ]
            },
            "time": {
                "start": 1720516793.835427,
                "finish": 1720516794.697913,
                "duration": 0.8624858856201172,
                "processing": 0.07323503494262695,
                "date_start": "2024-07-09T11:19:53+02:00",
                "date_finish": "2024-07-09T11:19:54+02:00",
                "operating": 0
            },
            "total": 4
        }

Returned Data

Name
type

Description

result
object

The root element of the response. Contains a single key types

types
type[]

A list of smart processes, each corresponding to the structure of the type object

time
time

Information about the request execution time

total
integer

The total number of records found

Error Handling

HTTP status: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

403

allowed_only_intranet_user

Action allowed only for intranet users

Occurs if the user is not an intranet user

400

ACCESS_DENIED

Access denied

Occurs if the user does not have administrative rights in CRM

400

INVALID_ARG_VALUE

Invalid filter: field 'field_n' is not allowed in filter

Occurs when passing a field field_n not present in the smart process to the filter parameter

400

INVALID_ARG_VALUE

Invalid filter: field 'field_n' has invalid value

Occurs when passing an incorrect value_n for the field field_n in the filter parameter

400

INVALID_ARG_VALUE

Invalid order: field 'field_n' is not allowed in order

Occurs when passing a field field_n not present in the smart process to the order parameter

400

INVALID_ARG_VALUE

Invalid order: allowed sort directions are ASC, DESC. But got 'invalid_value' for field 'field_n'

Occurs when passing an incorrect value_n for the field field_n in the order parameter

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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

Continue Learning

Previous
Get custom type by entityTypeId
Next
Delete custom type