Get Source by ID biconnector.source.get

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 method biconnector.source.get returns information about the source by its identifier.

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

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the source, which can be obtained using the methods biconnector.source.list and biconnector.source.add

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":6,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/biconnector.source.get
        
// 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 the payload returned in result (match the "response handling" section of the page)
        type SourceGetResult = {
          item: {
            connection: {
              id: number
              type: string
              code: string
              title: string
              description: string
              active: boolean
              // Dates come as "2025-03-20 14:50:06", not as an ISO string
              dateCreate: string | null
              dateUpdate: string | null
              createdById: number
              updatedById: number
            }
            connectorId: number
            settings: Array<{
              code: string
              name: string
              type: string
              value: string
              id: number
            }>
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<SourceGetResult | BiconnectorError>({
            method: 'biconnector.source.get',
            params: {
              id: 6,
            },
            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 ('error' in result) {
              console.error(result.error.error, result.error.error_description)
            } else {
              console.info(result.item.connection.id, result.item.connection.title, result.item.settings)
            }
          }
        } 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 getSource() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'biconnector.source.get',
                params: {
                  id: 6,
                },
                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(result.item.connection.id, result.item.connection.title, result.item.settings)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getSource)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.biconnector.source.get(
                bitrix_id=6,
            ).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.get',
                    [
                        'id' => 6,
                    ]
                );
        
            $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.get',
            {
                id: 6,
            },
            (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.get',
            [
                'id' => 6
            ]
        );
        
        // 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.get", b24.Params{
        	"id": 6,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("biconnector.source.get: %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.get: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        var item struct {
        	ConnectorID b24.ID `json:"connectorId"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ConnectorID)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "item": {
                    "connection": {
                        "id": 6,
                        "type": "rest",
                        "code": "rest_1",
                        "title": "Rest source SQL",
                        "description": "Connection for working with mySql",
                        "active": true,
                        "dateCreate": "2025-03-20 14:50:06",
                        "dateUpdate": "2025-03-20 14:50:06",
                        "createdById": 1,
                        "updatedById": 1
                    },
                    "connectorId": 1,
                    "settings": [
                        {
                            "code": "token",
                            "name": "Token",
                            "type": "STRING",
                            "value": "a1b2c3d4e5",
                            "id": 8
                        }
                    ]
                }
            },
            "time": {
                "start": 1742929480.368097,
                "finish": 1742929480.449558,
                "duration": 0.08146095275878906,
                "processing": 0.006555080413818359,
                "date_start": "2025-03-25T19:04:40+00:00",
                "date_finish": "2025-03-25T19:04:40+00:00"
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response. It contains the single item key

result.item
object

Source data (detailed description)

time
time

Information about the request execution time

The item object

Name
type

Description

connection
object

Connection data: the source's own fields (detailed description)

connectorId
integer

Identifier of the connector the source is linked to

settings
array

Authorization parameters of the source — one object per connector parameter (detailed description)

The connection object

Name
type

Description

id
integer

Unique identifier of the source

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

title
string

Source name

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

The settings object

Name
type

Description

id
integer

Identifier of the saved parameter

code
string

Parameter code set by the connector

name
string

Parameter name that the user sees in the interface

type
string

Parameter type: STRING or INT

value
string

Value specified when the source was created or updated. It arrives in plain text, including passwords and tokens

Error Handling

HTTP Status: 200

{
            "result": {
                "error": {
                    "error": "VALIDATION_ID_NOT_PROVIDED",
                    "error_description": "ID is missing."
                }
            }
        }
        

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

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_ID_NOT_PROVIDED

ID is missing.

Identifier is not provided

VALIDATION_INVALID_ID_FORMAT

ID has to be a positive integer.

Invalid ID format

SOURCE_NOT_FOUND

Source was not found.

The source does not exist or belongs to another application

CONNECTOR_NOT_FOUND

Connector was not found.

The connector the source is linked to was not found

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