Get a List of Knowledge Bases note.collection.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:
noteWho can execute the method: a user with access to the Knowledge base module
The note.collection.list method returns a list of Knowledge bases available to the user.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
pagination |
Pagination object. Object structure description |
Parameter Pagination
|
Name |
Description |
|
limit |
Page size. Allowed values: from Default: |
|
afterCursor |
Next page cursor. Pass the |
Parameter afterCursor
|
Name |
Description |
|
position* |
The Required if |
|
id* |
The identifier of the last knowledge base from the previous page. Required if |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/note.collection.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"pagination":{"limit":50,"afterCursor":{"position":100,"id":42}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"pagination":{"limit":50,"afterCursor":{"position":100,"id":42}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.collection.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CollectionListResult = {
items: Array<{
id: number
name: string
position: number
policyLevel: string
createdBy: number
updatedBy: number
createdAt: ISODate
updatedAt: ISODate
}>
nextCursor: {
position: number
id: number
} | null
}
try {
const response = await $b24.actions.v3.call.make<CollectionListResult>({
method: 'note.collection.list',
params: {
pagination: {
limit: 50,
afterCursor: {
position: 100,
id: 42,
},
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Collections:', result.items.length, result.nextCursor)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listCollections() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.collection.list',
params: {
pagination: {
limit: 50,
afterCursor: {
position: 100,
id: 42,
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Collections:', result.items.length, result.nextCursor)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listCollections)
</script>
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'note.collection.list',
[
'pagination' => [
'limit' => 50,
'afterCursor' => [
'position' => 100,
'id' => 42,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing collections: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'note.collection.list',
{
pagination: {
limit: 50,
afterCursor: {
position: 100,
id: 42
}
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'note.collection.list',
[
'pagination' => [
'limit' => 50,
'afterCursor' => [
'position' => 100,
'id' => 42,
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"items": [
{
"id": 1,
"name": "Product documentation",
"position": 100,
"policyLevel": "view",
"createdBy": 1,
"updatedBy": 1,
"createdAt": "2026-04-20T12:00:00Z",
"updatedAt": "2026-04-21T09:15:30Z"
}
],
"nextCursor": {
"position": 100,
"id": 1
}
},
"time": {
"start": 1780639200,
"finish": 1780639200.224321,
"duration": 0.2243211269378662,
"processing": 0.18721413612365723,
"date_start": "2026-06-19T10:00:00+03:00",
"date_finish": "2026-06-19T10:00:00+03:00",
"operating_reset_at": 1780639800,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing a list of knowledge bases |
|
items |
List of knowledge bases available to the user |
|
items[] |
Knowledge base object |
|
id |
Knowledge base identifier |
|
name |
Knowledge base name |
|
position |
Position of the knowledge base in the overall list |
|
policyLevel |
Base access policy of the knowledge base. Possible values:
|
|
createdBy |
Knowledge base author identifier |
|
updatedBy |
Last knowledge base editor identifier |
|
createdAt |
Knowledge base creation date and time in UTC |
|
updatedAt |
Knowledge base last modified date and time in UTC |
|
nextCursor |
Next page cursor or |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 403
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION",
"message": "Access denied"
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
The user does not have access to the Knowledge Base module |
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 |