Get Document crm.documentgenerator.document.get

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: crm

Who can execute the method: a user with "view" access permission for document generator documents

The method crm.documentgenerator.document.get returns the document data by its identifier.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id^* `integer`	Document identifier

Method Feature

pdfUrl and imageUrl may be absent immediately after the document is created or updated, as the conversion is performed asynchronously. If the links are needed right away, repeat the request after 30-40 seconds.

Code Examples

How to Use Examples in Documentation

Example of retrieving a document with identifier 61.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":61,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.get

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.document.get',
        		{
        			id: 61,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.get',
                    [
                        'id' => 61,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting document: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.document.get',
            {
                id: 61,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.get',
            [
                'id' => 61,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "document": {
                    "changeStampsEnabled": false,
                    "changeStampsDisabledReason": "The template does not have seals and signatures",
                    "changeQrCodeEnabled": false,
                    "qrCodeEnabled": false,
                    "changeQrCodeDisabledReason": "The template does not have a QR code",
                    "products": {
                        "currencyId": "EUR",
                        "totalSum": "0.00",
                        "totalRows": 0
                    },
                    "downloadUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=61",
                    "publicUrl": null,
                    "title": "Demo Product Implementation 2026-001",
                    "number": "2026-001",
                    "id": "61",
                    "createTime": "2026-03-20T13:51:45+01:00",
                    "createdBy": "577",
                    "updateTime": "2026-03-20T13:51:45+01:00",
                    "updatedBy": null,
                    "stampsEnabled": true,
                    "isTransformationError": false,
                    "values": {
                        "productsTableVariant": "",
                        "_creationMethod": "rest",
                        "stampsEnabled": true
                    },
                    "templateId": "39",
                    "pullTag": "TRANSFORMDOCUMENT61",
                    "imageUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getImage&SITE_ID=s1&id=61",
                    "pdfUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=61",
                    "emailDiskFile": 5609,
                    "entityId": "101",
                    "entityTypeId": "2",
                    "downloadUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.download.json?...",
                    "imageUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.getImage.json?...",
                    "pdfUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.getPdf.json?..."
                }
            },
            "time": {
                "start": 1774006578,
                "finish": 1774006578.790473,
                "duration": 0.7904729843139648,
                "processing": 0,
                "date_start": "2026-03-20T14:36:18+01:00",
                "date_finish": "2026-03-20T14:36:18+01:00",
                "operating_reset_at": 1774007178,
                "operating": 0.23765993118286133
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Returns the `result` object
time `time`	Information about the request execution time

Type result

Name `type`	Description
document `object`	Document data. The structure is described in the `document` type

Type document

Name `type`	Description
id `integer` \| `string`	Document identifier
title `string`	Document title
number `string`	Document number
createTime `datetime`	Document creation date
updateTime `datetime`	Document update date
createdBy `integer` \| `string`	Identifier of the user who created the document
updatedBy `integer` \| `string` \| `null`	Identifier of the user who updated the document
changeStampsEnabled `boolean`	Can the stamp and signature substitution feature be changed
changeStampsDisabledReason `string`	Reason why the stamp and signature substitution feature cannot be changed
changeQrCodeEnabled `boolean`	Can the QR code be enabled or disabled
qrCodeEnabled `boolean`	Current state of the QR code
changeQrCodeDisabledReason `string`	Reason why the QR code cannot be changed
products `object`	Summary information about the document's products (`currencyId`, `totalSum`, `totalRows`)
stampsEnabled `boolean`	Stamp and signature substitution feature indicator
downloadUrl `string`	Link to download the document
downloadUrlMachine `string`	Link to download the document for machine access
imageUrl `string`	Link to the document image. May be an empty string immediately after creation or update
imageUrlMachine `string`	Link to the document image for machine access
pdfUrl `string`	Link to the PDF document. May be an empty string immediately after creation or update
pdfUrlMachine `string`	Link to the PDF document for machine access
publicUrl `string` \| `null`	Public link to the document
isTransformationError `boolean`	Indicator of document conversion error
transformationErrorMessage `string`	Text of the conversion error, if `isTransformationError = true`
transformationErrorCode `string`	Code of the conversion error, if `isTransformationError = true`
templateId `integer` \| `string`	Identifier of the document template
pullTag `string`	Tag for the document transformation event
emailDiskFile `integer`	Identifier of the file on Drive for sending via email
entityTypeId `integer` \| `string`	Identifier of the CRM object type
entityId `integer` \| `string`	Identifier of the CRM object
values `object`	Field values of the document

Error Handling

HTTP Status: 400

{
            "error": "DOCGEN_ACCESS_ERROR",
            "error_description": "Access denied"
        }

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
`DOCGEN_ACCESS_ERROR`	Access denied	No access to the document
`0`	Document not found	Document with the specified `id` not found or unavailable
`Empty value`	Document not found	Document does not belong to the `crm` module
`100`	Bitrix\DocumentGenerator\Document constructor must be is public	Required parameter `id` not provided
`Empty value`	You do not have permissions to view documents	Insufficient rights to view document generator documents
`Empty value`	Module documentgenerator is not installed	The `documentgenerator` module is unavailable

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Continue Learning

Modify Document

Get List of Documents

Get Document crm.documentgenerator.document.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type resultType result

Type documentType document

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning