List of File Versions for disk.file.getVersions

Scope: disk

Who can execute the method: a user with "Read" access permission for the specified file

The method disk.file.getVersions returns a list of file versions.

Versions are returned in descending order of creation date.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the file.

The identifier can be obtained using the method disk.storage.getchildren if the file is located at the root of the storage, and using the method disk.folder.getchildren if the file is located in a folder

filter
array

An array in the following format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }
        

where:

  • field_n — the name of the field to filter by
  • value_n — the filter value

You can add a prefix to the keys field_n to specify the filter operation.
Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • % — LIKE, substring search. The % symbol should not be included in the filter value. The search looks for the substring at any position in the string
  • =% — LIKE, substring search. The % symbol should be included in the value. Examples:
    • "test%" — searches for values starting with "test"
    • "%test" — searches for values ending with "test"
    • "%test%" — searches for values where "test" can be at any position
  • %= — LIKE (similar to =%)
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

Available fields for filtering:

  • ID — version identifier
  • SIZE — size of the version in bytes
  • NAME — name of the file at the time the version was created
  • CREATE_TIME — time of version creation
  • CREATED_BY — identifier of the user who created the version

start
integer

This parameter is used for managing pagination.

The page size for results is always static — 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N - 1) * 50, where N — the desired page number

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":9043,"filter":{"NAME":"%test%"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.file.getVersions
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":9043,"filter":{"NAME":"%test%"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.file.getVersions
        
try
        {
            const response = await $b24.callMethod(
                'disk.file.getVersions',
                {
                    id: 9043,
                    filter: {
                        NAME: '%test%',
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Fetched file versions:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.file.getVersions',
                    [
                        'id' => 9043,
                        'filter' => [
                            'NAME' => '%test%'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching file versions: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.file.getVersions",
            {
                id: 9043,
                filter: {
                    NAME: '%test%'
                },
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'disk.file.getVersions',
            [
                'id' => 9043,
                'filter' => [
                    'NAME' => '%test%'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP Status: 200

{
            "result": [
                {
                "ID": "7201",
                "OBJECT_ID": "9043",
                "SIZE": "21796",
                "NAME": "Test №2.docx",
                "GLOBAL_CONTENT_VERSION": "5",
                "CREATE_TIME": "2026-02-17T12:21:22+02:00",
                "CREATED_BY": "1271",
                "DOWNLOAD_URL": "https://test.bitrix24.com/rest/download.json?auth=343794690000071b006e2cf2000004f500000746484b1f82771b3434ff80eb15edc8f8&token=disk%7CaWQ9NzIwMSZzZXJ2aWNlPXZlcnNpb24mXz0zdHFiVHY5bkNPWm5hVk1rRm92TXlzZUdUSDNTanlVZQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU56SXdNU1p6WlhKMmFXTmxQWFpsY25OcGIyNG1YejB6ZEhGaVZIWTVia05QV201aFZrMXJSbTkyVFhselpVZFVTRE5UYW5sVlpRPT18MzQzNzk0NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDc0NjQ4NGIxZjgyNzcxYjM0MzRmZjgwZWIxNWVkYzhmOCI%3D.dy270nYUZXvxmyBAR1vYnUtn%2Bkn%2FSClb2cIWT8FkOn0%3D"
                },
                {
                "ID": "7199",
                "OBJECT_ID": "9043",
                "SIZE": "21756",
                "NAME": "test.docx",
                "GLOBAL_CONTENT_VERSION": "3",
                "CREATE_TIME": "2026-02-17T12:15:06+02:00",
                "CREATED_BY": "1269",
                "DOWNLOAD_URL": "https://test.bitrix24.com/rest/download.json?auth=343794690000071b006e2cf2000004f500000746484b1f82771b3434ff80eb15edc8f8&token=disk%7CaWQ9NzE5OSZzZXJ2aWNlPXZlcnNpb24mXz1Uall3RkZRa0NPMTBncklPM2tYYmxNajRmSWQ2ekVLNg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU56RTVPU1p6WlhKMmFXTmxQWFpsY25OcGIyNG1YejFVYWxsM1JrWlJhME5QTVRCbmNrbFBNMnRZWW14TmFqUm1TV1EyZWtWTE5nPT18MzQzNzk0NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDc0NjQ4NGIxZjgyNzcxYjM0MzRmZjgwZWIxNWVkYzhmOCI%3D.mtFVuU%2F1h4eGP1VROTj7n4PDUDOSc4suh90NuNPQyyQ%3D"
                }
            ],
            "total": 2,
            "time": {
                "start": 1771320110,
                "finish": 1771320110.716905,
                "duration": 0.7169051170349121,
                "processing": 0,
                "date_start": "2026-02-17T12:21:50+02:00",
                "date_finish": "2026-02-17T12:21:50+02:00",
                "operating_reset_at": 1771320710,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
array

List of file versions.

An empty array means there are no versions that meet the filter criteria

ID
integer

Version identifier

OBJECT_ID
integer

Identifier of the file to which the version belongs

SIZE
integer

Size of the version in bytes

NAME
string

Name of the file at the time the version was created

GLOBAL_CONTENT_VERSION
integer

Incremental version counter for the file

CREATE_TIME
string

Time of version creation

CREATED_BY
integer

Identifier of the user who created the version

DOWNLOAD_URL
string

Link to download the version

total
integer

Total number of file versions

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error":"ERROR_ARGUMENT",
            "error_description":"Invalid value of parameter {Parameter #0}"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

ERROR_ARGUMENT

Invalid value of parameter

The required parameter id is missing

ERROR_NOT_FOUND

Could not find entity with id X

The file with the specified id was not found

ACCESS_DENIED

Access denied

Insufficient permissions to retrieve file versions

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning