Get the list of connectors biconnector.connector.list
Scope:
biconnectorWho can execute the method: user with access to the "Analyst's workspace" section
The method biconnector.connector.list returns a list of connectors based on a filter. It is an implementation of the list method for connectors.
Method Parameters
|
Name |
Description |
|
select |
List of fields that must be filled in the connectors in the selection. By default, all fields are taken |
|
filter |
Filter for selecting connectors. Example format:
You can add a prefix to the keys
The list of available fields for filtering can be found using the method biconnector.connector.fields |
|
order |
Sorting parameters. Example format:
|
|
page |
Controls pagination. The page size of results is 50 records. To navigate through results, pass the page number |
Code Examples
How to Use Examples in Documentation
Get the list of connectors where:
- the name starts with
MyConnector - the description is not empty
Display only the necessary fields:
- identifier
id - name
title - endpoint for checking the availability of the source
urlCheck - creation date
dateCreate
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"SELECT": [
"id",
"title",
"urlCheck",
"dateCreate"
],
"FILTER": {
"%=title": "MyConnector%",
"!description": ""
},
"ORDER": {
"dateCreate": "DESC"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.connector.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"SELECT": [
"id",
"title",
"urlCheck",
"dateCreate"
],
"FILTER": {
"%=title": "MyConnector%",
"!description": ""
},
"ORDER": {
"dateCreate": "DESC"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.connector.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'biconnector.connector.list',
{
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
},
(progress) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('biconnector.connector.list', {
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('biconnector.connector.list', {
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
}, 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(
'biconnector.connector.list',
[
'select' => [
"id",
"title",
"urlCheck",
"dateCreate"
],
'filter' => [
'%=title' => "MyConnector%",
'!description' => ''
],
'order' => [
'dateCreate' => "DESC"
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling biconnector.connector.list: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.connector.list',
{
select: [
"id",
"title",
"urlCheck",
"dateCreate"
],
filter: {
'%=title': "MyConnector%",
'!description': ''
},
order: {
dateCreate: "DESC"
}
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.connector.list',
[
'select' => [
"id",
"title",
"urlCheck",
"dateCreate"
],
'filter' => [
'%=title' => "MyConnector%",
'!description' => ''
],
'order' => [
'dateCreate' => "DESC"
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": [
{
"id": "11",
"title": "MyConnector_2",
"urlCheck": "https://new_example.com/check",
"dateCreate": "2025-03-24 07:25:59"
},
{
"id": "9",
"title": "MyConnector",
"urlCheck": "https://example.com/check",
"dateCreate": "2025-03-21 12:22:32"
}
],
"time": {
"start": 1742804947.923552,
"finish": 1742804947.995446,
"duration": 0.07189393043518066,
"processing": 0.0017020702362060547,
"date_start": "2025-03-24T08:29:07+00:00",
"date_finish": "2025-03-24T08:29:07+00:00"
}
}
Returned Data
|
result |
The root element of the response. Contains an array of objects with information about the fields of connectors. It should be noted that the structure of fields may change due to the |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 200
{
"error": "VALIDATION_SELECT_TYPE",
"error_description": "Parameter \"select\" must be array."
}
|
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 |
Value |
|
|
Parameter "select" must be array. |
The |
|
|
Parameter "filter" must be array. |
The |
|
|
Parameter "order" must be array. |
The |
|
|
Field "#TITLE#" is not allowed in the "select". |
These fields are not allowed in the selection |
|
|
Field "#TITLE#" is not allowed in the "filter". |
These fields are not allowed in the filter |
|
|
Field "#TITLE#" is not allowed in the "order". |
These fields are not allowed for sorting |
|
|
Field "logic" must be either "AND" or "OR". |
The |
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Update the biconnector.connector.update
- Get Connector by ID biconnector.connector.get
- Create Connector biconnector.connector.add
- Delete Connector biconnector.connector.delete
- Get Connector Fields biconnector.connector.fields