Get a list of custom types crm.type.list

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
        
    BX24.callMethod(
            'crm.type.list', 
            {
                filter: {
                    "0": {
                        logic: 'OR',
                        "0": {
                            "%title": "5",
                        },
                        "1": {
                            "%title": "0",
                        },
                    },
                },
                order: {
                    id: 'DESC',
                },
            },
            (result) => {
                if (result.error())
                {
                    console.error(result.error());
        
                    return;
                }
        
                console.info(result.data());
            },
        );
        
    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
        
    BX24.callMethod(
            'crm.type.list',
            {
                filter: {
                    isAutomationEnabled: 'Y',
                    isBizProcEnabled: "Y",
                    isCategoriesEnabled: "Y",
                    isClientEnabled: "Y",
                },
            },
            (result) => {
                if (result.error())
                {
                    console.error(result.error());
        
                    return;
                }
        
                console.info(result.data());
            },
        );
        
    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>';

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 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

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: 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

Previous
Get custom type by entityTypeId
Next
Delete custom type