Get a List of Document Files note.file.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:
noteWho can execute the method: a user with access to the Knowledge base module and "View" permissions for the document
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The note.file.list method returns the files attached to a document, page by page, along with their attachment dates.
A file uploaded with the note.file.add method and not inserted into the document text is eventually deleted by background cleanup. The period is counted from the createdAt date.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
documentId* |
Document identifier. The identifier can be obtained using the note.document.list method. The list is also available for an archived document or a document in the Recycle Bin, provided the user can open it |
|
pagination |
Pagination object. Object structure description. Omit this parameter for the first page |
Parameter Pagination
|
Name |
Description |
|
limit |
Number of files per page. Allowed values: from Default: |
|
afterCursor |
Next page cursor. Pass the The cursor structure is internal and may change. Do not build the cursor manually |
To retrieve all files of a document, call the method without pagination.afterCursor, then pass result.nextCursor from each response to pagination.afterCursor until result.nextCursor becomes null.
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.file.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":131,"pagination":{"limit":1}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.file.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":131,"pagination":{"limit":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.file.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FileListResult = {
items: Array<{
id: number
documentId: number
name: string
size: number
mimeType: string
assetType: 'image' | 'video' | 'file'
assetMarkdown: string
createdAt: ISODate
}>
nextCursor: Record<string, unknown> | null
}
try {
const response = await $b24.actions.v3.call.make<FileListResult>({
method: 'note.file.list',
params: {
documentId: 131,
pagination: {
limit: 1,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Files:', 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 listFiles() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.file.list',
params: {
documentId: 131,
pagination: {
limit: 1,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Files:', result.items.length, result.nextCursor)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listFiles)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.note.file.list(
document_id=131,
pagination={
"limit": 1,
},
).response
result = bitrix_response.result
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}")
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.file.list',
[
'documentId' => 131,
'pagination' => [
'limit' => 1,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $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.file.list',
{
documentId: 131,
pagination: {
limit: 1,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
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.file.list',
[
'documentId' => 131,
'pagination' => [
'limit' => 1,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "note.file.list", b24.Params{
"documentId": 131,
"pagination": b24.Params{
"limit": 1,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("note.file.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
Name string `json:"name"`
AssetMarkdown string `json:"assetMarkdown"`
CreatedAt string `json:"createdAt"`
} `json:"items"`
// Pass the cursor to the next request unchanged.
NextCursor json.RawMessage `json:"nextCursor"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, item := range result.Items {
fmt.Println(item.ID, item.Name, item.CreatedAt)
}
Response Handling
HTTP status: 200
{
"result": {
"nextCursor": {
"id": 39387
},
"items": [
{
"id": 39387,
"documentId": 131,
"name": "diagram.png",
"size": 70,
"mimeType": "image/png",
"assetType": "image",
"assetMarkdown": "[[image fileId=39387]]",
"createdAt": "2026-10-21T15:38:14+03:00"
}
]
},
"time": {
"start": 1792586295,
"finish": 1792586295.867693,
"duration": 0.8676929473876953,
"processing": 0,
"date_start": "2026-10-21T15:38:15+03:00",
"date_finish": "2026-10-21T15:38:15+03:00",
"operating_reset_at": 1792586880,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the list of files and the cursor |
|
result.items |
Array of files on the page, sorted by identifier in ascending order |
|
result.items[].id |
File identifier |
|
result.items[].documentId |
Document identifier |
|
result.items[].name |
File name |
|
result.items[].size |
File size in bytes |
|
result.items[].mimeType |
File MIME type |
|
result.items[].assetType |
Attachment type. Possible values:
|
|
result.items[].assetMarkdown |
Markdown block for inserting the file into the document text. To check whether the file is inserted into the text, search for this block in the document's |
|
result.items[].createdAt |
Date and time the file was attached to the document, in ISO 8601 format with a time zone. The background cleanup period for files not inserted into the text is counted from this date |
|
result.nextCursor |
Next page cursor. Pass it to |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating request object.",
"validation": [
{
"message": "Required field \"documentId\" is missing.",
"field": "documentId"
}
]
}
}
|
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
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field "documentId" is missing |
Add |
|
|
This request requires data type "int" in field "documentId" |
Pass the identifier as a number |
|
|
must be a number |
Pass a number |
|
|
must be a number |
Pass the cursor from |
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 |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID #ID# was not found |
The document does not exist or is not accessible to the user |
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 |