Get Source Fields biconnector.source.fields
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:
biconnectorWho can execute the method: A user who has both the "Access to BI Builder" and "Access to Analytics Hub" permissions
The biconnector.source.fields method returns a description of the source fields.
The purpose of each field is described in the source fields table.
The method returns a static schema of the source fields: it is the same in any Bitrix24 and does not depend on which sources were created. Unlike the other methods of the family, this method is available to a webhook, but it still checks both permissions and returns the ACCESS_DENIED error without them
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.source.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/biconnector.source.fields
// 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
}
}
type FieldDescription = {
title: string
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type SourceFieldsResult = {
fields: FieldDescription[]
}
try {
const response = await $b24.actions.v2.call.make<SourceFieldsResult | BiconnectorError>({
method: 'biconnector.source.fields',
params: {},
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('Source fields:', result.fields)
}
}
} 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 getSourceFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.source.fields',
params: {},
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('Source fields:', result.fields)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSourceFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.source.fields().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.fields',
[]
);
$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 'Success: ' . print_r($data, true);
}
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'biconnector.source.fields',
{},
(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.fields',
[]
);
// 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.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.source.fields: %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.fields: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
// The method wraps the response in an object with the "fields" key.
raw, ok := b24.Unwrap(res.Result, "fields")
if !ok {
return fmt.Errorf("no fields key in the response")
}
var items []struct {
Title string `json:"title"`
Type string `json:"type"`
IsRequired bool `json:"isRequired"`
IsReadOnly bool `json:"isReadOnly"`
IsImmutable bool `json:"isImmutable"`
IsMultiple bool `json:"isMultiple"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.Title)
}
Response Handling
HTTP status: 200
{
"result": {
"fields": [
{
"title": "id",
"type": "integer",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "title",
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false
},
{
"title": "type",
"type": "string",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "code",
"type": "string",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "description",
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false
},
{
"title": "active",
"type": "boolean",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false
},
{
"title": "dateCreate",
"type": "datetime",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "dateUpdate",
"type": "datetime",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "createdById",
"type": "integer",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "updatedById",
"type": "integer",
"isRequired": true,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false
},
{
"title": "connectorId",
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false
},
{
"title": "settings",
"type": "array",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": true
}
]
},
"time": {
"start": 1742896156.448294,
"finish": 1742896156.503291,
"duration": 0.05499696731567383,
"processing": 0.0004570484161376953,
"date_start": "2025-03-25T09:49:16+00:00",
"date_finish": "2025-03-25T09:49:16+00:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. It contains the single |
|
result.fields |
Array of source field descriptors, one element per field (detailed description) |
|
time |
Information about the request execution time |
Element of the fields array
|
Name |
Description |
|
title |
Name of the source field. The full list of fields and their purpose is in the source fields table |
|
type |
Field type. The method returns the |
|
isRequired |
Indicates that the field is required in the object schema. On creation, you only have to pass the fields whose |
|
isReadOnly |
The field is read-only |
|
isImmutable |
The field value can be set only once and only when a new element is created. A source has one such field — |
|
isMultiple |
Multiple field. If it is |
The method returns the active field with isReadOnly: false, but the biconnector.source.add and biconnector.source.update methods do not read its value.
The settings field has isMultiple set to true, yet the add and update methods accept it as an object on input, not as an array. Both forms are covered in the Settings Field section.
Error Handling
HTTP status: 200
{
"result": {
"error": {
"error": "ACCESS_DENIED",
"error_description": "Access denied."
}
}
}
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Access denied. |
One of the two permissions is missing, or BI Builder external data sources are not available on this Bitrix24 |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |