Get a List of Vendor Bindings to Documents catalog.documentcontractor.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: catalog

Who can execute the method: a user with the following access permissions:
— "View" on the document type "Incoming",
— "View" on the Inventory Accounting section,
— "View" on the Product Catalog

The method catalog.documentcontractor.list returns a list of vendor bindings to inventory accounting documents. By default, filters are applied to the request that limit the selection based on the current user's permissions.

Method Parameters

Required parameters are marked with *

Name `type`	Description
select `array`	An array containing the list of fields from catalog_documentcontractor that need to be selected. If the array is not provided or an empty array is passed, all available fields of the document will be selected.
filter `object`	An object for filtering the selected bindings in the format `{"field_1": "value_1", ..., "field_N": "value_N"}`. Possible values for `field` correspond to the fields of the catalog_documentcontractor object. An additional prefix can be specified for the key to clarify the filter's behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `=` — exact match `!=`, `!` — not equal `@` — IN, an array is passed as the value `!@` — NOT IN, an array is passed as the value `%` — LIKE, substring search. The `%` symbol should not 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%"` — searches for values starting with "mol" `"%mol"` — searches for values ending with "mol" `"%mol%"` — searches for values where "mol" can be in any position `!%` — NOT LIKE, substring search. The `%` symbol should not be included in the filter value. The search is conducted from both sides. `!=%` — NOT LIKE, substring search. The `%` symbol must be included 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 absent in any position `=` — equal, exact match, used by default `!=` — not equal `!` — not equal
order `object`	An object for sorting the selected documents in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` correspond to the fields of the catalog_documentcontractor object. Possible values for `order`: `asc` — in ascending order `desc` — in descending order By default, results are sorted in ascending order by `id`.
start `integer`	This parameter is used to manage pagination. The page size is 50 records. To select the second page of results, pass the value `50`. To select the third page of results, pass the value `100`, and so on. The formula for calculating the `start` parameter value: `start = (N-1) * 50`, where `N` is the desired page number. Or pass the value from the `next` key in the response.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","documentId"],"filter":{"documentId":7},"order":{"id":"ASC"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.documentcontractor.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","documentId"],"filter":{"documentId":7},"order":{"id":"ASC"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.documentcontractor.list

// callListMethod: Retrieves all data at once.
        // Use only for small selections (< 1000 items) due to high
        // memory load.
        
        try {
        const response = await $b24.callListMethod(
            'catalog.documentcontractor.list',
            {
            select: ["id", "documentId"],
            filter: { "documentId": 7 },
            order: { "id": "ASC" },
            start: 0
            },
            (progress) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Selects data in parts using an iterator.
        // Use for large volumes of data for efficient memory consumption.
        
        try {
        const generator = $b24.fetchListMethod('catalog.documentcontractor.list', {
            select: ["id", "documentId"],
            filter: { "documentId": 7 },
            order: { "id": "ASC" },
            start: 0
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // callMethod: Manual control of pagination through the start parameter.
        // Use for precise control over request batches.
        // Less efficient for large data than fetchListMethod.
        
        try {
        const response = await $b24.callMethod('catalog.documentcontractor.list', {
            select: ["id", "documentId"],
            filter: { "documentId": 7 },
            order: { "id": "ASC" },
            start: 0
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.documentcontractor.list',
                    [
                        'select' => ["id", "documentId"],
                        'filter' => ['documentId' => 7],
                        'order' => ['id' => 'ASC'],
                        'start' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.documentcontractor.list',
            {
                select: ["id", "documentId"],
                filter: { "documentId": 7 },
                order: { "id": "ASC" }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
        
                    if (result.more())
                    {
                        result.next();
                    }
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.documentcontractor.list',
            [
                'select' => ["id", "documentId"],
                'filter' => ['documentId' => 7],
                'order' => ['id' => 'ASC'],
                'start' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Code: 200

{
            "result": {
                "documentContractor": [
                {
                    "documentId": 7,
                    "id": 5
                }
                ]
            },
            "total": 1,
            "time": {
                "start": 1766146580,
                "finish": 1766146580.866608,
                "duration": 0.8666079044342041,
                "processing": 0,
                "date_start": "2025-12-19T15:16:20+01:00",
                "date_finish": "2025-12-19T15:16:20+01:00",
                "operating_reset_at": 1766147180,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	The root element of the response
documentContractor `catalog_documentContractor[]`	A list of contractor bindings; the response structure depends on the `select` parameter
next `integer`	Offset pointer for the next page. Pass this value to the `start` parameter to retrieve the next 50 records
total `integer`	The total number of documents
time `time`	Information about the request execution time

Error Handling

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

HTTP Code: 400

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

Possible Error Codes

Code	Description	Value
`0`	Access denied	Insufficient permissions to view the document or bindings
`0`	Contractors should be provided by CRM	The CRM module is not active as a vendor for contractors

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

Get Binding Fields

Overview of Methods

Get a List of Vendor Bindings to Documents catalog.documentcontractor.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning