Get the list of datasets biconnector.dataset.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 "Analyst Workspace" section
The method biconnector.dataset.list returns a list of datasets based on a filter. It is an implementation of the listing method for datasets.
Method Parameters
|
Name |
Description |
|
select |
A list of fields that must be populated in the datasets in the selection. By default, all fields are taken. |
|
filter |
Filter for selecting datasets. Example format:
You can add a prefix to the keys
The list of available fields for filtering can be found using the method biconnector.dataset.fields. The filter does not support the |
|
order |
Sorting parameters. Example format:
where:
|
|
page |
Controls pagination. The page size of results is 50 records. To navigate through the results, pass the page number. |
Code Examples
How to Use Examples in Documentation
Get the list of sources where:
- the name starts with
Sales - the description is not empty
- the source ID equals
2or4
For clarity, select only the necessary fields:
- ID
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"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.dataset.list
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"
},
"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
// Shape of each DatasetItem returned in result[]
type DatasetItem = {
id: string
name: string
description: string
}
try {
// biconnector.dataset.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<DatasetItem[]>({
method: 'biconnector.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'Sales%',
'!description': '',
'@sourceId': [2, 4],
},
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('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). 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.dataset.list',
params: {
select: ['id', 'name', 'description'],
filter: {
'%=name': 'Sales%',
'!description': '',
'@sourceId': [2, 4],
},
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('Datasets page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDatasets)
</script>
try {
$response = $b24Service
->core
->call(
'biconnector.dataset.list',
[
'select' => ["id", "name", "description"],
'filter' => [
'%=name' => "Sales%",
'!description' => "",
"@sourceId" => [2, 4]
],
'order' => [
'dateCreate' => "DESC"
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($response->getError()) {
error_log($response->getError());
echo 'Error: ' . $response->getError();
} else {
echo 'Success: ' . print_r($result, true);
// Your data processing logic
processData($result);
}
} 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"
}
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.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"]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": [
{
"id": "9",
"name": "sales_data_main",
"description": "Monthly sales report"
},
{
"id": "6",
"name": "sales_data_first_branch",
"description": "Monthly sales report for first branch"
},
{
"id": "5",
"name": "sales_data_second_branch",
"description": "Monthly sales report for second branch"
}
],
"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
|
result |
The root element of the response. Contains an array of objects with information about the fields of the datasets. It should be noted that the structure of the fields may change due to the |
|
time |
Information about the execution time of the request. |
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. |
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 |