Get a List of Requisites by Filter crm.requisite.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: a user with "read" access permission for contacts and companies

This method retrieves a list of company details based on a filter.

Method Parameters

Name
type

Description

select
array

An array containing the list of fields to be selected (see requisite fields).

If not provided or an empty array is passed, all available requisite fields will be selected.

filter
object

An object for filtering the selected requisites in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field correspond to requisite fields.

An additional prefix can be specified for the key to clarify the filter behavior. 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 does not need to be included in the filter value. The search looks for the substring in any position of the string.

  • =% — LIKE, substring search. The % symbol must be included in the value. Examples:

    • "mol%" — searching for values starting with "mol"
    • "%mol" — searching for values ending with "mol"
    • "%mol%" — searching for values where "mol" can be in any position.

  • %= — LIKE (see description above)

  • !% — NOT LIKE, substring search. The % symbol does not need to be included in the filter value. The search is performed from both sides.

  • !=% — NOT LIKE, substring search. The % symbol must be included in the value. Examples:

    • "mol%" — searching for values not starting with "mol"
    • "%mol" — searching for values not ending with "mol"
    • "%mol%" — searching for values where the substring "mol" is not present in any position.

  • !%= — NOT LIKE (see description above)

  • = — equal, exact match (used by default)

  • != — not equal

  • ! — not equal

order
object

An object for sorting selected attributes in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field correspond to attribute fields.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

start
integer

A parameter used to control pagination.

The results page size is always static: 50 records.

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

Formula for calculating the start parameter value:

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

Code Example

How to Use Examples in Documentation

  1. Retrieving company details by template ID

    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"DATE_CREATE":"ASC"},"filter":{"PRESET_ID":"1"},"select":["ENTITY_TYPE_ID","ENTITY_ID","ID","NAME"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.list
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{"DATE_CREATE":"ASC"},"filter":{"PRESET_ID":"1"},"select":["ENTITY_TYPE_ID","ENTITY_ID","ID","NAME"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each RequisiteResult returned in result[]
        type RequisiteResult = {
          ENTITY_TYPE_ID: string
          ENTITY_ID: string
          ID: string
          NAME: string
        }
        
        try {
          // crm.requisite.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<RequisiteResult[]>({
            method: 'crm.requisite.list',
            params: {
              order: { DATE_CREATE: 'ASC' },
              filter: { PRESET_ID: '1' },
              select: ['ENTITY_TYPE_ID', 'ENTITY_ID', 'ID', 'NAME'],
              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('Requisites:', result.length, result)
          }
        } 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 getRequisiteList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // crm.requisite.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.requisite.list',
                params: {
                  order: { DATE_CREATE: 'ASC' },
                  filter: { PRESET_ID: '1' },
                  select: ['ENTITY_TYPE_ID', 'ENTITY_ID', 'ID', 'NAME'],
                  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('Requisites:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getRequisiteList)
        </script>

    Example

    
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.requisite.list(
                order={"DATE_CREATE": "ASC"},
                filter={"PRESET_ID": "1"},
                select=["ENTITY_TYPE_ID", "ENTITY_ID", "ID", "NAME"],
                start=0,
            ).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.requisite.list(
                order={"DATE_CREATE": "ASC"},
                filter={"PRESET_ID": "1"},
                select=["ENTITY_TYPE_ID", "ENTITY_ID", "ID", "NAME"],
            ).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.requisite.list(
                filter={"PRESET_ID": "1"},
                select=["ENTITY_TYPE_ID", "ENTITY_ID", "ID", "NAME"],
                order={"ID": "DESC"},
            ).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.requisite.list',
            [
                'order' => ["DATE_CREATE" => "ASC"],
                'filter' => ["PRESET_ID" => "1"],
                'select' => ["ENTITY_TYPE_ID", "ENTITY_ID", "ID", "NAME"]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

  2. Retrieving the value of a custom field in company details

    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{},"filter":{"ID":"51"},"select":["UF_CRM_1707997209"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.list
        
    curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"order":{},"filter":{"ID":"51"},"select":["UF_CRM_1707997209"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each RequisiteUserField returned in result[]
        type RequisiteUserField = {
          UF_CRM_1707997209: string
        }
        
        try {
          // crm.requisite.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<RequisiteUserField[]>({
            method: 'crm.requisite.list',
            params: {
              order: {},
              filter: { ID: '51' }, // Requisite ID
              select: ['UF_CRM_1707997209'], // User-defined field ID
              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('User field value:', result[0]?.UF_CRM_1707997209)
          }
        } 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 getRequisiteUserField() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // crm.requisite.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.requisite.list',
                params: {
                  order: {},
                  filter: { ID: '51' }, // Requisite ID
                  select: ['UF_CRM_1707997209'], // User-defined field ID
                  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('User field value:', result[0]?.UF_CRM_1707997209)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getRequisiteUserField)
        </script>
        
    
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.requisite.list(
                order={},
                filter={"ID": "51"},
                select=["UF_CRM_1707997209"],
            ).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}")
        
    require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.list',
            [
                'order' => [],
                'filter' => ['ID' => '51'],
                'select' => ['UF_CRM_1707997209']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

  1. Response from example 1:

    {
        "result": [
            {
            "ENTITY_TYPE_ID": "4",
            "ENTITY_ID": "3027",
            "ID": "40",
            "NAME": "Organization"
            },
            {
            "ENTITY_TYPE_ID": "4",
            "ENTITY_ID": "3028",
            "ID": "41",
            "NAME": "Headquarters details"
            },
            {
            "ENTITY_TYPE_ID": "4",
            "ENTITY_ID": "3028",
            "ID": "42",
            "NAME": "Branch in Chernyakhovsk"
            }
        ],
        "total": 3,
        "time": {
            "start": 1717150154.197056,
            "finish": 1717150154.505106,
            "duration": 0.30804991722106934,
            "processing": 0.030454158782958984,
            "date_start": "2024-05-31T12:09:14+02:00",
            "date_finish": "2024-05-31T12:09:14+02:00",
            "operating": 0
        }
        }

  2. Response from example 2:

    {
            "result": [
                {
                    "UF_CRM_1707997209": "45"
                }
            ],
            "total": 1,
            "time": {
                "start": 1717151052.551011,
                "finish": 1717151052.94743,
                "duration": 0.39641880989074707,
                "processing": 0.028468847274780273,
                "date_start": "2024-05-31T12:24:12+02:00",
                "date_finish": "2024-05-31T12:24:12+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
array

An array of objects containing information from the selected requisites. Each element contains the selected requisite fields

total
integer

The total number of records found

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": 0,
            "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

Code

Error text

Description

0

Access denied.

Insufficient access permissions to retrieve the list of requisites.

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 detail by id
Next
Delete detail and related objects