Get a List of Datasets biconnector.dataset.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:
biconnectorWho can execute the method: A user who has both the "Access to BI Builder" and "Access to Analytics Hub" permissions
DEPRECATED
Development of the method has been discontinued. Use biconnector.table.list.
The biconnector.dataset.list method returns a list of datasets by filter.
The method works only in the context of an application and returns only the datasets that the application created itself. When called via a webhook, the method returns the ACCESS_DENIED error
Method Parameters
All parameters are optional: the method can be called with an empty request body.
|
Name |
Description |
|
select |
List of fields to be filled in for the datasets in the selection. Allowed values are the field names from the schema of the biconnector.dataset.fields method and The This is the only method of the family that returns |
|
filter |
Filter for selecting datasets. Example format:
A prefix can be added to the
The list of available fields for filtering can be obtained using the biconnector.dataset.fields method. The
Any other value of the The filter does not support the |
|
order |
Sorting parameters. Example format:
where:
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 |
|
page |
Number of the selection page, numbering starts at one, and the default value is 1. The page size is fixed at 50 records. A non-numeric, zero, or negative value causes no error: the method silently returns the first page. The method returns neither the total number of datasets nor a link to the next page, so there is only one sign that the selection has ended: the page returned fewer than 50 elements, more about navigation |
Code Examples
How to Use Examples in Documentation
Retrieve the list of datasets where:
- the name starts with
sales - the description is not empty
- the source identifier equals
2or4
Return only the required fields:
- identifier
id - name
name - description
description
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id", "name", "description"],
"filter": {
"%=name": "sales%",
"!description": "",
"@sourceId": [2, 4]
},
"order": {
"dateCreate": "DESC"
},
"page": 1,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.dataset.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 DatasetItem returned in result[]
type DatasetItem = {
id: number
name: string
description: string
}
try {
// biconnector.dataset.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<DatasetItem[] | BiconnectorError>({
method: 'biconnector.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'sales%',
'!description': '',
'@sourceId': [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('Datasets page:', 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 listDatasets() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// biconnector.dataset.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.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'sales%',
'!description': '',
'@sourceId': [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('Datasets page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDatasets)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.dataset.list(
select=[
"id",
"name",
"description",
],
filter={
"%=name": "sales%",
"!description": "",
"@sourceId": [
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.dataset.list',
[
'select' => ["id", "name", "description"],
'filter' => [
'%=name' => "sales%",
'!description' => "",
"@sourceId" => [2, 4]
],
'order' => [
'dateCreate' => "DESC"
],
'page' => 1
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
$data = $result->data();
// 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) {
error_log($e->getMessage());
echo 'Error calling biconnector.dataset.list: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.dataset.list',
{
select: ["id", "name", "description"],
filter: {
'%=name': "sales%",
'!description': "",
"@sourceId": [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.dataset.list',
[
'select' => ["id", "name", "description"],
'filter' => ['%=name' => "sales%", '!description' => "", '@sourceId' => [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.dataset.list", b24.Params{
"select": []string{"id", "name", "description"},
"filter": b24.Params{
"%=name": "sales%",
"!description": "",
"@sourceId": []int{2, 4},
},
"order": b24.Params{
"dateCreate": "DESC",
},
"page": 1,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("biconnector.dataset.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.dataset.list: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
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.Name)
}
// 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": 9,
"name": "sales_data_main",
"description": "Monthly sales report"
},
{
"id": 6,
"name": "sales_data_first_filial",
"description": "Monthly sales report for first filial"
},
{
"id": 5,
"name": "sales_data_second_filial",
"description": "Monthly sales report for second filial"
}
],
"time": {
"start": 1743061675.963969,
"finish": 1743061676.064591,
"duration": 0.10062193870544434,
"processing": 0.011152029037475586,
"date_start": "2025-03-27T07:47:55+00:00",
"date_finish": "2025-03-27T07:47:56+00:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. A flat array of datasets without an additional wrapper (detailed description) |
|
time |
Information about the request execution time |
Element of the result array
An element of the selection is the same dataset that biconnector.dataset.get returns, but without the fields array and with an additional sourceId key.
|
Name |
Description |
|
id |
Unique identifier of the dataset |
|
sourceId |
Identifier of the source the dataset is linked to. Of all the methods of the family, only |
|
type |
Dataset type. For datasets created via the REST API, the value is always |
|
name |
Dataset name |
|
verboseName |
User-friendly dataset name. If it is not set, an empty string is returned |
|
description |
Dataset description |
|
externalCode |
External code of the dataset — the name the application knows it by |
|
externalName |
External name of the dataset |
|
dateCreate |
Date the dataset was created, in the |
|
dateUpdate |
Date the dataset was updated, in the |
|
createdById |
Identifier of the user who created the dataset |
|
updatedById |
Identifier of the user who updated the dataset. For a dataset that has never been updated, the value is |
|
externalId |
Identifier of the BI Builder dataset created together with the object by the biconnector.dataset.add method. For objects created with the biconnector.table.add method, the value is always |
|
csvDelimiter |
Column delimiter in a CSV file. For datasets of a REST source it arrives as an empty string |
|
csvEncoding |
Encoding of a CSV file. For datasets of a REST source it arrives as an empty string |
|
csvHasHeaders |
Indicates that the first row of a CSV file holds the column headers. For datasets of a REST source it arrives as |
This is what an element looks like when the method is called without select:
{
"id": 27,
"type": "rest",
"name": "sales_orders",
"verboseName": "Orders",
"description": "Orders from an external service",
"externalCode": "sales_orders",
"externalName": "Sales orders",
"dateCreate": "2026-09-16 12:00:46",
"dateUpdate": null,
"createdById": 1,
"updatedById": 0,
"externalId": 31,
"csvDelimiter": "",
"csvEncoding": "",
"csvHasHeaders": false,
"sourceId": 3
}
Do not list the date fields — dateCreate and dateUpdate — in select. With an explicit selection, the date is not formatted and an empty {} object arrives instead of a string. To retrieve the dates, call the method without select or with select: ["*"]
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 |
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, BI Builder external data sources are not available on this Bitrix24, or the method was called via a webhook or outside the application context |
|
|
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 |
|
|
Invalid order "#VALUE#". |
The sorting direction in |
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 |
Continue Learning
- Deprecated biconnector.dataset.* Methods: Overview of Methods
- Create Dataset biconnector.dataset.add
- Update Dataset biconnector.dataset.update
- Get dataset by id biconnector.dataset.get
- Delete dataset biconnector.dataset.delete
- Update Dataset Fields biconnector.dataset.fields.update
- Get Dataset Fields biconnector.dataset.fields