Get a List of Links for Requisites crm.requisite.link.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:
crmWho can execute the method: any user
Retrieves a list of links for company details based on the filter.
Method Parameters
|
Name |
Description |
|
select |
An array of fields to select (see requisite link fields). If the array is not provided or an empty array is passed, all available fields for requisite links will be selected. |
|
filter |
An object for filtering the selected requisite links in the format Possible values for An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting the selected requisite links in the format Possible values for Possible values for
|
|
start |
This parameter is used to manage pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value The formula for calculating the
|
Description of the Requisite Link Fields with the CRM Object
|
Name |
Description |
|
ENTITY_TYPE_ID |
Identifier of the object type to which the link belongs. The following types can be used:
Object type identifiers can be obtained using the method crm.enum.ownertype |
|
ENTITY_ID |
Identifier of the object to which the link belongs. Object identifiers can be obtained using the following methods: crm.deal.list, crm.quote.list, crm.item.list |
|
REQUISITE_ID |
Identifier of the client's requisite selected for the object. Requisite identifiers can be obtained using the method crm.requisite.list |
|
BANK_DETAIL_ID |
Identifier of the client's bank requisite selected for the object. Bank requisite identifiers can be obtained using the method crm.requisite.bankdetail.list |
|
MC_REQUISITE_ID |
Identifier of my company's requisite selected for the object. Requisite identifiers can be obtained using the method crm.requisite.list |
|
MC_BANK_DETAIL_ID |
Identifier of my company's bank requisite selected for the object. Bank requisite identifiers can be obtained using the method crm.requisite.bankdetail.list |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ENTITY_ID":"ASC"},"filter":{"@ENTITY_TYPE_ID":[1,2,7,31]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.link.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ENTITY_ID":"ASC"},"filter":{"@ENTITY_TYPE_ID":[1,2,7,31]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.link.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 item returned in result[]
type RequisiteLinkItem = {
ENTITY_TYPE_ID: string
ENTITY_ID: string
REQUISITE_ID: string
BANK_DETAIL_ID: string
MC_REQUISITE_ID: string
MC_BANK_DETAIL_ID: string
}
try {
// crm.requisite.link.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<RequisiteLinkItem[]>({
method: 'crm.requisite.link.list',
params: {
order: { ENTITY_ID: 'ASC' },
filter: { '@ENTITY_TYPE_ID': [1, 2, 7, 31] }, // Leads, deals, quotes, invoices
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('Requisite links count:', result.length, 'First item:', result[0])
}
} 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 listRequisiteLinks() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.requisite.link.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.link.list',
params: {
order: { ENTITY_ID: 'ASC' },
filter: { '@ENTITY_TYPE_ID': [1, 2, 7, 31] }, // Leads, deals, quotes, invoices
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('Requisite links count:', result.length, 'First item:', result[0])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listRequisiteLinks)
</script>
try {
$response = $b24Service
->core
->call(
'crm.requisite.link.list',
[
'order' => ['ENTITY_ID' => 'ASC'],
'filter' => ['@ENTITY_TYPE_ID' => [1, 2, 7, 31]],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
if ($result->more()) {
$result->next();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching requisite links: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.link.list", {
order: {"ENTITY_ID": "ASC"},
filter: {"@ENTITY_TYPE_ID": [1, 2, 7, 31]} // Leads, deals, quotes, invoices.
},
function (result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.dir(result.data());
if (result.more())
result.next();
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.link.list',
[
'order' => ['ENTITY_ID' => 'ASC'],
'filter' => ['@ENTITY_TYPE_ID' => [1, 2, 7, 31]]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.link.list(
order={"ENTITY_ID": "ASC"},
filter={"@ENTITY_TYPE_ID": [1, 2, 7, 31]},
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.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.link.list(
order={"ENTITY_ID": "ASC"},
filter={"@ENTITY_TYPE_ID": [1, 2, 7, 31]},
).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.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.link.list(
order={"ENTITY_ID": "ASC"},
filter={"@ENTITY_TYPE_ID": [1, 2, 7, 31]},
).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}")
Response Handling
HTTP status: 200
{
"result": [
{
"ENTITY_TYPE_ID": "7",
"ENTITY_ID": "1",
"REQUISITE_ID": "0",
"BANK_DETAIL_ID": "0",
"MC_REQUISITE_ID": "0",
"MC_BANK_DETAIL_ID": "0"
},
{
"ENTITY_TYPE_ID": "7",
"ENTITY_ID": "2",
"REQUISITE_ID": "0",
"BANK_DETAIL_ID": "0",
"MC_REQUISITE_ID": "0",
"MC_BANK_DETAIL_ID": "0"
},
{
"ENTITY_TYPE_ID": "7",
"ENTITY_ID": "3",
"REQUISITE_ID": "0",
"BANK_DETAIL_ID": "0",
"MC_REQUISITE_ID": "0",
"MC_BANK_DETAIL_ID": "0"
},
{
"ENTITY_TYPE_ID": "7",
"ENTITY_ID": "4",
"REQUISITE_ID": "7",
"BANK_DETAIL_ID": "0",
"MC_REQUISITE_ID": "2",
"MC_BANK_DETAIL_ID": "2"
},
{
"ENTITY_TYPE_ID": "7",
"ENTITY_ID": "5",
"REQUISITE_ID": "0",
"BANK_DETAIL_ID": "0",
"MC_REQUISITE_ID": "2",
"MC_BANK_DETAIL_ID": "2"
},
{
"ENTITY_TYPE_ID": "7",
"ENTITY_ID": "6",
"REQUISITE_ID": "0",
"BANK_DETAIL_ID": "0",
"MC_REQUISITE_ID": "2",
"MC_BANK_DETAIL_ID": "2"
},
{
"ENTITY_TYPE_ID": "2",
"ENTITY_ID": "25",
"REQUISITE_ID": "38",
"BANK_DETAIL_ID": "0",
"MC_REQUISITE_ID": "0",
"MC_BANK_DETAIL_ID": "0"
},
{
"ENTITY_TYPE_ID": "31",
"ENTITY_ID": "315",
"REQUISITE_ID": "60",
"BANK_DETAIL_ID": "24",
"MC_REQUISITE_ID": "2",
"MC_BANK_DETAIL_ID": "2"
}
],
"total": 8,
"time": {
"start": 1718709631.410351,
"finish": 1718709631.771324,
"duration": 0.36097288131713867,
"processing": 0.015230178833007812,
"date_start": "2024-06-18T13:20:31+02:00",
"date_finish": "2024-06-18T13:20:31+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An array of objects with information from the selected requisite links. Each element contains the selected requisite link fields |
|
total |
The total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error": 0,
"error_description": "Access denied."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Insufficient access permissions to retrieve the list of requisite links |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |