How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bitrix24

Bitrix24 Document Generator API

The Document Generator API from Bitrix24 — 29 operation(s) for document generator.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bitrix24 Document Generator API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document Generator. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 29 operations across 29 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

29 operations 29 paths 3 schemas 29 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
Contact
Bitrix24 Developer Support
License
MIT
Resource Areas
1

Authentication & Security 2

Bitrix24 Document Generator API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 29

Across 29 paths, the API surfaces 29 operations — 29 POST. Each is listed below with its method, path, parameters, and response codes.

Document Generator 29
POST
/documentgenerator.document.add
Create a New Document Based on a Template documentgenerator.document.add
documentgenerator_document_add body → 2004XX
POST
/documentgenerator.document.delete
Delete document documentgenerator.document.delete
documentgenerator_document_delete body → 2004XX
POST
/documentgenerator.document.enablepublicurl
Enable or disable public link for document documentgenerator.document.enablepublicurl
documentgenerator_document_enablepublicurl body → 2004XX
POST
/documentgenerator.document.get
Get Document by ID documentgenerator.document.get
documentgenerator_document_get body → 2004XX
POST
/documentgenerator.document.getfields
Get the list of fields for the document documentgenerator.document.getfields
documentgenerator_document_getfields body → 2004XX
POST
/documentgenerator.document.list
Get the List of Documents documentgenerator.document.list
documentgenerator_document_list body → 2004XX
POST
/documentgenerator.document.update
Update Existing Document documentgenerator.document.update
documentgenerator_document_update body → 2004XX
POST
/documentgenerator.numerator.add
Add Document Generator Numerator: documentgenerator.numerator.add
documentgenerator_numerator_add body → 2004XX
POST
/documentgenerator.numerator.delete
Delete the documentgenerator.numerator.delete
documentgenerator_numerator_delete body → 2004XX
POST
/documentgenerator.numerator.get
Get Numerator by ID documentgenerator.numerator.get
documentgenerator_numerator_get body → 2004XX
POST
/documentgenerator.numerator.list
Get the List of Numerators documentgenerator.numerator.list
documentgenerator_numerator_list body → 2004XX
POST
/documentgenerator.numerator.update
Update the documentgenerator.numerator.update
documentgenerator_numerator_update body → 2004XX
POST
/documentgenerator.region.add
Add Region documentgenerator.region.add
documentgenerator_region_add body → 2004XX
POST
/documentgenerator.region.delete
Delete Region documentgenerator.region.delete
documentgenerator_region_delete body → 2004XX
POST
/documentgenerator.region.get
Get Region by ID documentgenerator.region.get
documentgenerator_region_get body → 2004XX
POST
/documentgenerator.region.list
Get the List of Regions documentgenerator.region.list
documentgenerator_region_list body → 2004XX
POST
/documentgenerator.region.update
Update Region documentgenerator.region.update
documentgenerator_region_update body → 2004XX
POST
/documentgenerator.role.add
Add Role documentgenerator.role.add
documentgenerator_role_add body → 2004XX
POST
/documentgenerator.role.delete
Delete Role documentgenerator.role.delete
documentgenerator_role_delete body → 2004XX
POST
/documentgenerator.role.fillaccesses
Bind Users to Roles documentgenerator.role.fillaccesses
documentgenerator_role_fillaccesses body → 2004XX
POST
/documentgenerator.role.get
Get Role by ID documentgenerator.role.get
documentgenerator_role_get body → 2004XX
POST
/documentgenerator.role.list
Get a List of Roles documentgenerator.role.list
documentgenerator_role_list body → 2004XX
POST
/documentgenerator.role.update
Change Role documentgenerator.role.update
documentgenerator_role_update body → 2004XX
POST
/documentgenerator.template.add
Upload Template documentgenerator.template.add
documentgenerator_template_add body → 2004XX
POST
/documentgenerator.template.delete
Delete Template documentgenerator.template.delete
documentgenerator_template_delete body → 2004XX
POST
/documentgenerator.template.get
Get Template by ID documentgenerator.template.get
documentgenerator_template_get body → 2004XX
POST
/documentgenerator.template.getfields
Get the List of Fields for documentgenerator.template.getfields
documentgenerator_template_getfields body → 2004XX
POST
/documentgenerator.template.list
Get a List of documentgenerator.template.list Templates
documentgenerator_template_list body → 2004XX
POST
/documentgenerator.template.update
Update Template documentgenerator.template.update
documentgenerator_template_update body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-document-generator-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
AE Profile APIs.io
Bitrix24 BIconnector API
AE Profile APIs.io
Bitrix24 Business Processes API
AE Profile APIs.io
Bitrix24 Calendar API
AE Profile APIs.io
Bitrix24 Chatbots API
AE Profile APIs.io
Bitrix24 Chats API
AE Profile APIs.io
Bitrix24 Company Structure API
AE Profile APIs.io
Bitrix24 CoPilot / AI API
AE Profile APIs.io
Bitrix24 CRM API
AE Profile APIs.io
Bitrix24 Data Storage API
AE Profile APIs.io
Bitrix24 Deprecated Methods API
AE Profile APIs.io
Bitrix24 Drive API
AE Profile APIs.io
#Document Generator
← Back to B APIs
API Details
ID
bitrix24:bitrix24-document-generator-api
Base URL
https://{installation}.bitrix24.com/rest/
Docs
https://apidocs.bitrix24.com/
Provider
Bitrix24
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bitrix24-document-generator-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bitrix24-document-generator-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Bitrix24 Document Generator API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.