Get a List of Sources biconnector.source.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: biconnector

Who can execute the method: A user who has both the "Access to BI Builder" and "Access to Analytics Hub" permissions

The biconnector.source.list method returns a list of sources by filter.

The method works only in the context of an application and returns only the sources that the application created itself. When called via a webhook, the method returns the ACCESS_DENIED error

The result page size is 50 records. The method returns neither the total number of sources nor a link to the next page, so list traversal is built on the page number: the selection has ended when fewer than 50 records arrive in the response.

Method Parameters

All parameters are optional: the method can be called with an empty request body.

Name
type

Description

select
string[]

List of fields to be filled in for the sources in the selection. Allowed values are the field names from the schema of the biconnector.source.fields method and *. By default all fields are taken, and the * value gives the same result.

If only the settings field is passed in select, the elements of the selection carry no id identifier

filter
object

Filter for selecting sources. Example format:

{
            "field_1": "value_1",
            "field_2": "value_2"
        }
        

A prefix can be added to the field_n keys to specify 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
  • % — LIKE, substring search. The % character does not need to be passed in the filter value. The search looks for the substring in any position of the string
  • =% — LIKE, substring search. The % character must be passed 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
  • %= — LIKE (similar to =%)
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

The list of available fields for filtering can be obtained using the biconnector.source.fields method.

The logic key defines how the filter conditions are combined:

  • AND — a source is included in the selection if all conditions are met. Used by default
  • OR — one met condition is enough

Any other value of the logic key causes the VALIDATION_INVALID_FILTER_LOGIC error.

The filter does not support the settings field; it will be ignored

order
object

Sorting parameters. Example format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        
  • field_n — the name of the field by which the sources will be sorted
  • value_n — a string type value, equal to:
    • ASC — ascending sort
    • DESC — descending sort

Without this parameter, no sorting is applied and the order of records in the selection is not guaranteed.

The direction value is case-insensitive, but the field accepts no other values. An empty string, a number, or any word other than ASC and DESC breaks off at the ORM level: the response arrives with HTTP status 400 and the ERROR_ARGUMENT error in the root, not inside result like the other errors of the section

Sorting, like the filter, does not work by the settings field

page
integer

Number of the result page. Numbering starts at one, and the default value is 1. A non-numeric, zero, or negative value causes no error: the method silently returns the first page. The start parameter, common to most list methods of the REST API, does not work here

Code Examples

How to Use Examples in Documentation

Get a list of sources where:

  • the name starts with Sql
  • the description is not empty
  • the connector identifier equals 2 or 4

Return only the required fields:

  • identifier id
  • name title
  • activity active
  • description description
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","title","active","description"],"filter":{"%=title":"Sql%","!description":"","@connectorId":[2,4]},"order":{"dateCreate":"DESC"},"page":1,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/biconnector.source.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
        
        // Methods of this section put errors inside result and answer with HTTP 200
        type BiconnectorError = {
          error: {
            error: string
            error_description: string
          }
        }
        
        // Shape of each SourceItem returned in result[]
        type SourceItem = {
          id: number
          title: string
          active: boolean
          description: string
        }
        
        try {
          // biconnector.source.list returns a single page (max 50 records). The list helpers
          // ($b24.actions.v2.callList.make, fetchList.make) do not work here: this method uses
          // its own `page` navigation and returns neither `total` nor `next`. Walk the pages
          // yourself, increasing `page` until a response comes back with fewer than 50 records.
          const response = await $b24.actions.v2.call.make<SourceItem[] | BiconnectorError>({
            method: 'biconnector.source.list',
            params: {
              select: ['id', 'title', 'active', 'description'],
              filter: {
                '%=title': 'Sql%',
                '!description': '',
                '@connectorId': [2, 4],
              },
              order: {
                dateCreate: 'DESC',
              },
              page: 1,
            },
            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
        
            // The SDK sees HTTP 200 as success, so check the error inside result yourself
            if (!Array.isArray(result)) {
              console.error(result.error.error, result.error.error_description)
            } else {
              console.info('Sources fetched:', 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 fetchSourceList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // biconnector.source.list returns a single page (max 50 records). The list helpers
              // ($b24.actions.v2.callList.make, fetchList.make) do not work here: this method uses
              // its own `page` navigation and returns neither `total` nor `next`. Walk the pages
              // yourself, increasing `page` until a response comes back with fewer than 50 records.
              const response = await $b24.actions.v2.call.make({
                method: 'biconnector.source.list',
                params: {
                  select: ['id', 'title', 'active', 'description'],
                  filter: {
                    '%=title': 'Sql%',
                    '!description': '',
                    '@connectorId': [2, 4],
                  },
                  order: {
                    dateCreate: 'DESC',
                  },
                  page: 1,
                },
                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
        
              // The SDK sees HTTP 200 as success, so check the error inside result yourself
              if (result && result.error) {
                console.error(result.error.error, result.error.error_description)
                return
              }
        
              console.info('Sources fetched:', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchSourceList)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.biconnector.source.list(
                select=[
                    "id",
                    "title",
                    "active",
                    "description",
                ],
                filter={
                    "%=title": "Sql%",
                    "!description": "",
                    "@connectorId": [
                        2,
                        4,
                    ],
                },
                order={
                    "dateCreate": "DESC",
                },
                page=1,
            ).response
            result = bitrix_response.result
        
            # Methods of this section put errors inside result and answer with HTTP 200
            if isinstance(result, dict) and "error" in result:
                print(
                    "BIconnector error",
                    f"error: {result['error']['error']}",
                    f"error_description: {result['error']['error_description']}",
                    sep="\n",
                )
            else:
                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}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.source.list',
                    [
                        'select' => [
                            "id",
                            "title",
                            "active",
                            "description"
                        ],
                        'filter' => [
                            '%=title'      => "Sql%",
                            '!description' => "",
                            "@connectorId" => [2, 4]
                        ],
                        'order'  => [
                            'dateCreate' => "DESC"
                        ],
                        'page'   => 1
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            $data = $result;
        
            // Methods of this section put errors inside result and answer with HTTP 200
            if (isset($data['error'])) {
                echo 'BIconnector error: ' . $data['error']['error'] . ': ' . $data['error']['error_description'];
            } else {
                echo 'Data: ' . print_r($data, true);
            }
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'biconnector.source.list',
            {
                select: [
                    "id",
                    "title",
                    "active",
                    "description"
                ],
                filter: {
                    '%=title': "Sql%",
                    '!description': "",
                    "@connectorId": [2, 4]
                },
                order: {
                    dateCreate: "DESC"
                },
                page: 1
            },
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                    return;
                }
        
                const data = result.data();
        
                // Methods of this section put errors inside result and answer with HTTP 200
                if (data && data.error) {
                    console.error(data.error.error, data.error.error_description);
                    return;
                }
        
                console.info(data);
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.source.list',
            [
                'select' => [
                    "id",
                    "title",
                    "active",
                    "description"
                ],
                'filter' => [
                    '%=title' => "Sql%",
                    '!description' => "",
                    '@connectorId' => [2, 4]
                ],
                'order' => [
                    'dateCreate' => "DESC"
                ],
                'page' => 1
            ]
        );
        
        // Methods of this section put errors inside result and answer with HTTP 200
        if (isset($result['result']['error'])) {
            echo 'BIconnector error: ' . $result['result']['error']['error']
                . ': ' . $result['result']['error']['error_description'];
        } else {
            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.source.list", b24.Params{
        	"select": []string{"id", "title", "active", "description"},
        	"filter": b24.Params{
        		"%=title":      "Sql%",
        		"!description": "",
        		"@connectorId": []int{2, 4},
        	},
        	"order": b24.Params{
        		"dateCreate": "DESC",
        	},
        	"page": 1,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("biconnector.source.list: %w", err)
        }
        
        // Methods of this section put errors inside result and answer with HTTP 200.
        var apiErr struct {
        	Error *struct {
        		Error       string `json:"error"`
        		Description string `json:"error_description"`
        	} `json:"error"`
        }
        if err := json.Unmarshal(res.Result, &apiErr); err == nil && apiErr.Error != nil {
        	return fmt.Errorf("biconnector.source.list: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
        }
        
        var items []struct {
        	ID          b24.ID `json:"id"`
        	Title       string `json:"title"`
        	Active      bool   `json:"active"`
        	Description string `json:"description"`
        }
        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)
        }
        
        // This method returns neither Total nor Next: pagination is built
        // on the page parameter, while 50 records keep arriving in the response.
        

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "id": 11,
                    "title": "Sql_host",
                    "active": true,
                    "description": "Connection for host reports"
                },
                {
                    "id": 10,
                    "title": "Sql_partner",
                    "active": false,
                    "description": "Connection for partner reports"
                }
            ],
            "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

Name
type

Description

result
array

Root element of the response. A flat array of sources without an additional wrapper (detailed description)

time
time

Information about the request execution time

Element of the result array

Name
type

Description

id
integer

Unique identifier of the source

title
string

Source name

type
string

Source type. For sources created via REST, the value is always rest

code
string

Source code. It is generated automatically using the rest_<connectorId> template

description
string

Source description

active
boolean

Source activity. An inactive source stops returning data

dateCreate
datetime

Date the source was created, in the Y-m-d H:i:s format

dateUpdate
datetime

Date the source was updated, in the Y-m-d H:i:s format

createdById
integer

Identifier of the user who created the source

updatedById
integer

Identifier of the user who updated the source

connectorId
integer

Identifier of the connector the source is linked to

settings
array

Authorization parameters of the source. The structure of an element is described in the Settings Field section

If the select parameter is specified, only the listed fields remain in the elements.

Error Handling

HTTP status: 200

{
            "result": {
                "error": {
                    "error": "VALIDATION_SELECT_TYPE",
                    "error_description": "Parameter \"select\" must be array."
                }
            }
        }
        

The method returns an error inside the result field and with HTTP status 200. Check result.error: the SDK wrappers parse only the top level of the response and treat such an error as a success

One error of the method arrives differently. If the order parameter receives a sorting direction other than ASC and DESC, the request breaks off at the ORM level: the response gets HTTP status 400, and the error code is in the root rather than inside result.

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Invalid order \"UPWARDS\""
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ACCESS_DENIED

Access denied.

One of the two permissions is missing, BI Builder external data sources are not available on this Bitrix24, or the method was called via a webhook or outside the application context

VALIDATION_SELECT_TYPE

Parameter "select" must be array.

The select parameter must be an array

VALIDATION_FILTER_TYPE

Parameter "filter" must be array.

The filter parameter must be an array

VALIDATION_ORDER_TYPE

Parameter "order" must be array.

The order parameter must be an array

VALIDATION_FIELD_NOT_ALLOWED_IN_SELECT

Field "#TITLE#" is not allowed in the "select".

These fields are not allowed in the selection

VALIDATION_FIELD_NOT_ALLOWED_IN_FILTER

Field "#TITLE#" is not allowed in the "filter".

These fields are not allowed in the filter

VALIDATION_FIELD_NOT_ALLOWED_IN_ORDER

Field "#TITLE#" is not allowed in the "order".

These fields are not allowed for sorting

VALIDATION_INVALID_FILTER_LOGIC

Field "logic" must be either "AND" or "OR".

The logic field can only have the value "AND" or "OR"

ERROR_ARGUMENT

Invalid order "#VALUE#".

The sorting direction in order differs from ASC and DESC. #VALUE# is replaced with the passed value in uppercase. This is the only error of the method with HTTP status 400: the code arrives in the root of the response, not inside result

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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