Get a list of matches for a natural or legal person sale.businessValuePersonDomain.list

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: sale

Who can execute the method: administrator

The method sale.businessValuePersonDomain.list retrieves a list of matches for a natural or legal person.

Method Parameters

Required parameters are marked with *

Name
type

Description

select
array

The array contains a list of fields to select.

If not provided or an empty array is passed, all available fields for matching a natural or legal person will be selected.

Possible values for array elements:

  • personTypeId
  • domain

filter
object

An object for filtering the selected matches for a natural or legal person in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field:

  • personTypeId
  • domain

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)
  • = — equals, exact match (used by default)
  • != - not equal

order
object

An object for sorting the selected matches for a natural or legal person in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field:

  • personTypeId
  • domain

Possible values for order:

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

start
integer

The parameter is used to manage pagination.

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

To select the second page of results, the value 50 must be passed. 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 desired page number

Code Examples

How to Use Examples in Documentation

-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["personTypeId"],"filter":{"=domain":"I"},"order":{"personTypeId":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.businessValuePersonDomain.list
        
-X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["personTypeId"],"filter":{"=domain":"I"},"order":{"personTypeId":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.businessValuePersonDomain.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
        
        type BusinessValuePersonDomain = {
          personTypeId: number
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type BusinessValuePersonDomainListResult = {
          businessValuePersonDomains: BusinessValuePersonDomain[]
        }
        
        // sale.businessValuePersonDomain.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.
        try {
          const response = await $b24.actions.v2.call.make<BusinessValuePersonDomainListResult>({
            method: 'sale.businessValuePersonDomain.list',
            params: {
              select: ['personTypeId'],
              filter: { '=domain': 'I' },
              order: { personTypeId: '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(result.businessValuePersonDomains.length, result.businessValuePersonDomains)
          }
        } 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 fetchBusinessValuePersonDomainList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // sale.businessValuePersonDomain.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: 'sale.businessValuePersonDomain.list',
                params: {
                  select: ['personTypeId'],
                  filter: { '=domain': 'I' },
                  order: { personTypeId: '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(result.businessValuePersonDomains.length, result.businessValuePersonDomains)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchBusinessValuePersonDomainList)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.businessValuePersonDomain.list',
                    [
                        'select' => ["personTypeId"],
                        'filter' => ["=domain" => "I"],
                        'order' => ["personTypeId" => "DESC"]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.businessValuePersonDomain.list',
            {
                select: ["personTypeId"],
                filter: {"=domain": "I"},
                order: {"personTypeId": "DESC"}
            }, 
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.businessValuePersonDomain.list',
            [
                'select' => ['personTypeId'],
                'filter' => ['=domain' => 'I'],
                'order' => ['personTypeId' => 'DESC']
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP status: 200

{
            "result": {
                "businessValuePersonDomains": [
                    {
                        "personTypeId": 3
                    },
                    {
                        "personTypeId": 2
                    }
                ]
            },
            "total": 2,
            "time": {
                "start": 1712326352.63409,
                "finish": 1712326352.8319,
                "duration": 0.197818040847778,
                "processing": 0.00833678245544434,
                "date_start": "2024-04-05T16:12:32+02:00",
                "date_finish": "2024-04-05T16:12:32+02:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

The root element of the response

businessValuePersonDomains
sale_business_value_person_domain[]

An array of objects with information about the selected matches

total
integer

The total number of records found

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

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

Code

Description

200040300010

No access to read

0

Other errors (e.g., fatal errors)

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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