Get Document File Data note.file.get
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's knowledge base
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.get method returns file metadata and a ready-to-use Markdown block to insert the attachment into a document.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
File identifier. The file identifier can be obtained in the response of the note.file.add method. |
|
documentId* |
Document identifier to which the file is attached. Use the same document identifier that you passed to the note.file.add method. |
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.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5001,"documentId":77}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.file.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5001,"documentId":77,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.file.get
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FileGetResult = {
item: {
id: number
documentId: number
name: string
size: number
mimeType: string
assetType: string
assetMarkdown: string
}
}
try {
const response = await $b24.actions.v3.call.make<FileGetResult>({
method: 'note.file.get',
params: {
id: 5001,
documentId: 77,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('File info:', result.item.assetMarkdown)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getFile() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.file.get',
params: {
id: 5001,
documentId: 77,
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('File info:', result.item.assetMarkdown)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getFile)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.note.file.get(
bitrix_id=5001,
document_id=77,
).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.get',
[
'id' => 5001,
'documentId' => 77,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting file info: ' . $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.get',
{
id: 5001,
documentId: 77
},
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.file.get',
[
'id' => 5001,
'documentId' => 77
]
);
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.get", b24.Params{
"id": 5001,
"documentId": 77,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("note.file.get: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
var item struct {
ID b24.ID `json:"id"`
DocumentID b24.ID `json:"documentId"`
Name string `json:"name"`
Size int `json:"size"`
MimeType string `json:"mimeType"`
AssetType string `json:"assetType"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.DocumentID)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 5001,
"documentId": 77,
"name": "diagram.png",
"size": 6321,
"mimeType": "image/png",
"assetType": "image",
"assetMarkdown": "[[image fileId=5001]]"
}
},
"time": {
"start": 1780392300,
"finish": 1780392300.194822,
"duration": 0.19482207298278809,
"processing": 0.15441107749938965,
"date_start": "2026-06-16T12:25:00+03:00",
"date_finish": "2026-06-16T12:25:00+03:00",
"operating_reset_at": 1780392900,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing the result of the file data retrieval. |
|
item |
Object containing file metadata. |
|
id |
Identifier of the file |
|
documentId |
Document identifier to which the file is attached. This is the same document identifier that you passed to the note.file.add method. |
|
name |
File name. |
|
size |
File size in bytes |
|
mimeType |
File MIME type. |
|
assetType |
Attachment type for Markdown. Possible values:
|
|
assetMarkdown |
Ready-to-use Markdown block for insertion into a document in To make the attachment appear in the document, pass this block to Before inserting an image or video, you can extend the block with scale and alignment parameters. For details, see the |
|
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": "Mandatory field `id` is missing",
"field": "id"
}
]
}
}
|
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 |
Add the specified field to the request body |
|
|
Field |
Ensure the provided value is of the correct type |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Document not found. |
Please check that the document exists, is not archived, is not in the trash, and is accessible to the user. |
|
|
File not found. |
Please check that the file exists and is attached to the specified document. |
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 |