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 -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
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DocumentGetResult = {
          document: {
            id: string
            title: string
            number: string
            createTime: ISODate
            updateTime: ISODate
            createdBy: string
            updatedBy: string | null
            changeStampsEnabled: boolean
            changeStampsDisabledReason: string
            changeQrCodeEnabled: boolean
            qrCodeEnabled: boolean
            changeQrCodeDisabledReason: string
            products: {
              currencyId: string
              totalSum: string
              totalRows: number
            }
            stampsEnabled: boolean
            downloadUrl: string
            downloadUrlMachine: string
            imageUrl: string
            imageUrlMachine: string
            pdfUrl: string
            pdfUrlMachine: string
            publicUrl: string | null
            isTransformationError: boolean
            templateId: string
            pullTag: string
            emailDiskFile: number
            entityTypeId: string
            entityId: string
            values: Record<string, unknown>
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<DocumentGetResult>({
            method: 'crm.documentgenerator.document.get',
            params: {
              id: 61,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.document.id, result.document.title, result.document.downloadUrl)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getDocument() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.documentgenerator.document.get',
                params: {
                  id: 61,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.document.id, result.document.title, result.document.downloadUrl)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDocument)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.documentgenerator.document.get(bitrix_id=61).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}")
        
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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.documentgenerator.document.get", b24.Params{
        	"id": 61,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.documentgenerator.document.get: %w", err)
        }
        
        // The method wraps the response in an object with the "document" key.
        raw, ok := b24.Unwrap(res.Result, "document")
        if !ok {
        	return fmt.Errorf("no document key in the response")
        }
        
        var item struct {
        	ChangeStampsEnabled        bool   `json:"changeStampsEnabled"`
        	ChangeStampsDisabledReason string `json:"changeStampsDisabledReason"`
        	ChangeQrCodeEnabled        bool   `json:"changeQrCodeEnabled"`
        	QrCodeEnabled              bool   `json:"qrCodeEnabled"`
        	ChangeQrCodeDisabledReason string `json:"changeQrCodeDisabledReason"`
        	DownloadUrl                string `json:"downloadUrl"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ChangeStampsEnabled, item.ChangeStampsDisabledReason)
        

Response Handling

HTTP status: 200

{
            "result": {
                "document": {
                    "changeStampsEnabled": false,
                    "changeStampsDisabledReason": "No seals or signatures in the template",
                    "changeQrCodeEnabled": false,
                    "qrCodeEnabled": false,
                    "changeQrCodeDisabledReason": "No QR code in the template",
                    "products": {
                        "currencyId": "UAH",
                        "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": "Demonstration implementation of product 2026-001",
                    "number": "2026-001",
                    "id": "61",
                    "createTime": "2026-03-20T13:51:45+03:00",
                    "createdBy": "577",
                    "updateTime": "2026-03-20T13:51:45+03: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+03:00",
                "date_finish": "2026-03-20T14:36:18+03: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

Result Type

Name
type

Description

document
object

Document data. The structure is described in the document type

Document Type

Name
type

Description

id
integer | string

Document identifier

title
string

Document name

number
string

Document number

createTime
datetime

Date of document creation

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 inclusion be changed

changeStampsDisabledReason
string

Reason why the stamp and signature inclusion 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 inclusion flag

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

Flag indicating a 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

Event tag for document transformation

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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 permissions to view document generator documents

Empty value

Module documentgenerator is not installed

The documentgenerator module is not available

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

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

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning