For AI agents: markdown of this page — /docs-content-en/note/collections/get.md documentation index — /llms.txt

Get a knowledge base

GET /v1/note/collections/:id

Returns a single knowledge base by its identifier. Use it when you know the knowledge base identifier and need its data.

Parameters

Parameter Type Required Description
id (path) number yes Knowledge base identifier. List: GET /v1/note/collections

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/note/collections/9 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/note/collections/9 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/note/collections/9', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Knowledge base:', data)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/note/collections/9', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

Field Type Description
success boolean Always true on success
data.id number Knowledge base identifier
data.name string Knowledge base name
data.position number Numeric position of the knowledge base
data.policyLevel string Access policy of the knowledge base. On the Bitrix24 account we checked — portal for the shared company knowledge base and private for the rest
data.accessLevel string Access level to the knowledge base. On the knowledge bases we checked — full
data.isArchived boolean true for an archived knowledge base
data.createdBy number Identifier of the employee who created the knowledge base. List: GET /v1/users
data.createdAt string Creation date in ISO 8601 format
data.updatedBy number Identifier of the employee who last modified the knowledge base. List: GET /v1/users
data.updatedAt string Last modification date in ISO 8601 format
data.markdownDescription string or null Knowledge base description in Markdown. On the knowledge bases we checked — null

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 9,
    "name": "Product documentation",
    "position": 100,
    "policyLevel": "private",
    "accessLevel": "full",
    "isArchived": false,
    "createdBy": 1269,
    "createdAt": "2026-06-23T19:01:03Z",
    "updatedBy": 1269,
    "updatedAt": "2026-06-23T19:05:39Z",
    "markdownDescription": null
  }
}

Error response example

404 — knowledge base not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Record with ID = `999999` not found"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS id is not a positive integer
404 ENTITY_NOT_FOUND Knowledge base with the specified id not found
403 SCOPE_DENIED The key lacks the note scope
401 TOKEN_MISSING The key has no configured tokens

Full list of common API errors — Errors.

Known specifics

An archived knowledge base is still returned. After archiving, the request returns 200 with isArchived: true — unlike the list, where such a knowledge base no longer appears. A deleted knowledge base returns 404.

See also