Count CRM Items v 3.0 crm.[type].aggregate

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 permission to view items of this CRM object type. For my company, a CRM administrator

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The crm.<type>.aggregate method returns the number of CRM items that match a filter. The object type is set by the <type> segment of the method name.

The method counts the same items that crm.<type>.list would return with the same filter: only items available to the user, without my companies in crm.company.aggregate and without recurring deal templates in crm.deal.aggregate.

Method Name for the Object Type

Object type

Method

Fields

Deal

crm.deal.aggregate

Deal fields

Lead

crm.lead.aggregate

Lead fields

Contact

crm.contact.aggregate

Contact fields

Company

crm.company.aggregate

Company fields

Estimate

crm.quote.aggregate

Estimate fields

Invoice

crm.smartinvoice.aggregate

Invoice fields

My company

crm.mycompany.aggregate

My company fields

SPA

crm.smartprocess<entityTypeId>.aggregate, for example, crm.smartprocess1038.aggregate

SPA fields

For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field.

The method name is written in lowercase: crm.smartinvoice.aggregate, not crm.smartInvoice.aggregate. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

select*
object

Aggregate function and field. The method accepts only one value — {"count": ["id"]}, the number of items.

Other functions and fields, for example, {"sum": ["opportunity"]} or {"count": ["title"]}, cause the BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION error, even though the OpenAPI description of the method lists the avg, sum, min, max, and countDistinct functions

filter
array

Item selection conditions in the REST 3.0 format. The format, operators, condition groups, and limits are the same as for the crm.<type>.list method.

If the parameter is not passed, the method counts all available items

The method does not accept the order and pagination parameters: if they are passed, it returns a sort or pagination error.

You can filter by fields whose filterable attribute is true in the crm.<type>.field.list response. Each object type has its own set of fields, which are described on these pages:

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.smartprocess1038.aggregate

The examples count SPA items with the type ID 1038 in pipeline 69 with an amount of 10,000 or more. For a different object type, replace the method name according to the table above.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":{"count":["id"]},"filter":[["categoryId","=",69],["opportunity",">=",10000]]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.aggregate
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":{"count":["id"]},"filter":[["categoryId","=",69],["opportunity",">=",10000]],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.aggregate
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ItemAggregateResult = {
          result: {
            count: {
              id: number
            }
          }
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<ItemAggregateResult>(
            'crm.smartprocess1038.aggregate',
            {
              select: {
                count: ['id'],
              },
              filter: [
                ['categoryId', '=', 69],
                ['opportunity', '>=', 10000],
              ],
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Count:', result.result.count.id)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function countItems() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.aggregate',
                {
                  select: {
                    count: ['id'],
                  },
                  filter: [
                    ['categoryId', '=', 69],
                    ['opportunity', '>=', 10000],
                  ],
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Count:', result.result.count.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', countItems)
        </script>
        

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.smartprocess1038.aggregate"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "select": {"count": ["id"]},
                    "filter": [
                        ["categoryId", "=", 69],
                        ["opportunity", ">=", 10000],
                    ],
                },
                prefer_version=3,
            )
            count = response["result"]["result"]["count"]["id"]
            print(count)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.smartprocess1038.aggregate',
                    [
                        'select' => [
                            'count' => ['id'],
                        ],
                        'filter' => [
                            ['categoryId', '=', 69],
                            ['opportunity', '>=', 10000],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'crm.smartprocess1038.aggregate',
            {
                select: {
                    count: ['id'],
                },
                filter: [
                    ['categoryId', '=', 69],
                    ['opportunity', '>=', 10000],
                ],
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.smartprocess1038.aggregate',
            [
                'select' => [
                    'count' => ['id'],
                ],
                'filter' => [
                    ['categoryId', '=', 69],
                    ['opportunity', '>=', 10000],
                ],
            ]
        );
        
        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.smartprocess1038.aggregate", b24.Params{
        	"select": b24.Params{
        		"count": []string{"id"},
        	},
        	"filter": []any{
        		[]any{"categoryId", "=", 69},
        		[]any{"opportunity", ">=", 10000},
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.aggregate: %w", err)
        }
        
        var aggregate struct {
        	Result struct {
        		Count struct {
        			ID int `json:"id"`
        		} `json:"count"`
        	} `json:"result"`
        }
        if err := json.Unmarshal(res.Result, &aggregate); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(aggregate.Result.Count.ID)
        

Response Handling

HTTP status: 200

{
            "result": {
                "result": {
                    "count": {
                        "id": 3
                    }
                }
            },
            "time": {
                "start": 1793706442,
                "finish": 1793706442.214798,
                "duration": 0.2147979736328125,
                "processing": 0,
                "date_start": "2026-11-03T14:47:22+03:00",
                "date_finish": "2026-11-03T14:47:22+03:00",
                "operating_reset_at": 1793707020,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.result
object

Aggregation results grouped by function

result.result.count
object

Result of the count function for the fields from select

result.result.count.id
integer

Number of items that match the filter. If no items match, 0

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION",
                "message": "Invalid field in \"select\": {\"sum\":[\"opportunity\"]}."
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

select

Required field select is missing

Pass "select": {"count": ["id"]}

#FIELD#

DTO #DTO# in field #FIELD# requires attribute Filterable to perform this request

The field cannot be used in a filter. Use fields whose filterable attribute is true in crm.<type>.field.list

#FIELD#

This request requires data type #TYPE# in field #FIELD#

Pass a value of the field type in the condition: a number, true or false, or a date and time with a time zone

Select Format Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field

Error description

How to Fix

-

Invalid field in select: #SELECT#

Pass select as the object {"count": ["id"]}. The method does not accept other functions, fields, or the array ["id"]

Filter Errors

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error description

How to Fix

-

Invalid filter #FILTER#

Check the condition from the error message against the description of the filter parameter. A common cause is a condition group inside an array without "type": "filter"

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION

Field

Error description

How to Fix

-

Unknown filter operator #OPERATOR#

Use the operators from the REST 3.0 overview

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity #DTO#

Check the field name in filter on the fields page of the object type

Extra Parameters

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION

Field

Error description

How to Fix

-

Invalid sort order #ORDER#

Remove order from the request

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error description

How to Fix

-

Incorrect pagination parameter value: #PAGINATION#

Remove pagination from the request

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.smartinvoice.aggregate. For an SPA, check entityTypeId with the crm.type.list method

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