Get a List of Connectors biconnector.connector.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:
biconnectorWho can execute the method: a user with access to the Analytics hub section
The biconnector.connector.list method returns a list of connectors by filter. It is a list-based method implementation 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:
A prefix can be added to the keys
The list of available fields for filtering can be obtained using the biconnector.connector.fields method |
|
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 a 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 source availability
urlCheck - Create 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
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each connector returned in result[]
type ConnectorItem = {
id: string
title: string
urlCheck: string
dateCreate: ISODate | null
}
try {
// biconnector.connector.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<ConnectorItem[]>({
method: 'biconnector.connector.list',
params: {
select: [
'id',
'title',
'urlCheck',
'dateCreate',
],
filter: {
'%=title': 'MyConnector%',
'!description': '',
},
order: {
dateCreate: '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('Connectors:', result.length, result)
}
} 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 loadConnectorList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// biconnector.connector.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: 'biconnector.connector.list',
params: {
select: [
'id',
'title',
'urlCheck',
'dateCreate',
],
filter: {
'%=title': 'MyConnector%',
'!description': '',
},
order: {
dateCreate: '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('Connectors:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', loadConnectorList)
</script>
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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "biconnector.connector.list", b24.Params{
"select": []string{"id", "title", "urlCheck", "dateCreate"},
"filter": b24.Params{
"%=title": "MyConnector%",
"!description": "",
},
"order": b24.Params{
"dateCreate": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.connector.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Title string `json:"title"`
UrlCheck string `json:"urlCheck"`
DateCreate string `json:"dateCreate"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
// Total and Next are filled in by list methods; for a full
// list traversal, use client.Core().Pages and Scan.
if res.Total != nil {
fmt.Println("total:", *res.Total)
}
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 |
Response root element. Contains an array of objects with information about connectors. Note that the field structure may be changed due to the |
|
time |
Information about the request execution time |
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 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 |