[{"data":1,"prerenderedAt":2418},["ShallowReactive",2],{"navigation":3,"-docs-api-reference":498,"-docs-api-reference-description":2407},[4],{"title":5,"path":6,"stem":7,"children":8,"page":47},"Docs","\u002Fdocs","docs",[9,78,383,390],{"title":10,"path":11,"stem":12,"children":13,"restApiVersion":15,"category":15,"description":15,"badge":15},"Get Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started\u002F1.index",[14,17,48,63],{"title":10,"path":11,"stem":12,"restApiVersion":15,"category":15,"description":16,"badge":15},null,"Quick start guide for working with the SDK for Bitrix24 REST API",{"title":18,"path":19,"stem":20,"children":21,"page":47},"Installation","\u002Fdocs\u002Fgetting-started\u002Finstallation","docs\u002F1.getting-started\u002F2.installation",[22,27,32,37,42],{"title":23,"path":24,"stem":25,"restApiVersion":15,"category":15,"description":26,"badge":15},"Vue","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fvue","docs\u002F1.getting-started\u002F2.installation\u002F1.vue","Guide for installing Bitrix24 JS SDK in Vue applications.",{"title":28,"path":29,"stem":30,"restApiVersion":15,"category":15,"description":31,"badge":15},"Nuxt","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fnuxt","docs\u002F1.getting-started\u002F2.installation\u002F2.nuxt","Guide for installing Bitrix24 JS SDK in Nuxt applications.",{"title":33,"path":34,"stem":35,"restApiVersion":15,"category":15,"description":36,"badge":15},"React","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Freact","docs\u002F1.getting-started\u002F2.installation\u002F3.react","Guide for installing Bitrix24 JS SDK in React applications.",{"title":38,"path":39,"stem":40,"restApiVersion":15,"category":15,"description":41,"badge":15},"Node.js","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fnodejs","docs\u002F1.getting-started\u002F2.installation\u002F4.nodejs","Guide for installing Bitrix24 JS SDK in Node.js applications.",{"title":43,"path":44,"stem":45,"restApiVersion":15,"category":15,"description":46,"badge":15},"UMD","\u002Fdocs\u002Fgetting-started\u002Finstallation\u002Fumd","docs\u002F1.getting-started\u002F2.installation\u002F5.umd","Guide for using UMD version Bitrix24 JS SDK in you applications.",false,{"title":49,"restApiVersion":15,"category":15,"description":15,"badge":15,"shadow":47,"path":50,"stem":51,"children":52,"page":47},"Migration","\u002Fdocs\u002Fgetting-started\u002Fmigration","docs\u002F1.getting-started\u002F3.migration",[53,58],{"title":54,"path":55,"stem":56,"restApiVersion":15,"category":15,"description":57,"badge":15},"v0 to v1","\u002Fdocs\u002Fgetting-started\u002Fmigration\u002Fv1","docs\u002F1.getting-started\u002F3.migration\u002F1.v1","A comprehensive guide to migrate your application from Bitrix24 JS SDK v0 to Bitrix24 JS SDK v1.",{"title":59,"path":60,"stem":61,"restApiVersion":15,"category":15,"description":62,"badge":15},"v2 to v3","\u002Fdocs\u002Fgetting-started\u002Fmigration\u002Fv3","docs\u002F1.getting-started\u002F3.migration\u002F2.v3","How to migrate off the deprecated REST surface that is removed in Bitrix24 JS SDK 3.0.0.",{"title":64,"restApiVersion":15,"category":15,"description":15,"badge":15,"path":65,"stem":66,"children":67,"page":47},"AI Tools","\u002Fdocs\u002Fgetting-started\u002Fai","docs\u002F1.getting-started\u002F7.ai",[68,73],{"title":69,"path":70,"stem":71,"restApiVersion":15,"category":15,"description":72,"badge":15},"Skills","\u002Fdocs\u002Fgetting-started\u002Fai\u002Fskills","docs\u002F1.getting-started\u002F7.ai\u002F1.skills","Task-focused skill files for AI coding agents working with @bitrix24\u002Fb24jssdk.",{"title":74,"path":75,"stem":76,"restApiVersion":15,"category":15,"description":77,"badge":15},"LLMs.txt","\u002Fdocs\u002Fgetting-started\u002Fai\u002Fllms-txt","docs\u002F1.getting-started\u002F7.ai\u002F2.llms-txt","How to get AI tools like Cursor, Windsurf, GitHub Copilot, ChatGPT, and Claude to understand Bitrix24 JS SDK methods, tools, and best practices.",{"title":79,"path":80,"stem":81,"children":82,"restApiVersion":15,"category":15,"description":15,"badge":15},"Working with the REST API","\u002Fdocs\u002Fworking-with-the-rest-api","docs\u002F2.working-with-the-rest-api\u002F0.index",[83,86,93,98,103,107,112,116,121,126,130,135,140,145,150,155,160,165,170,175,179,184,189,194,200,205,210,215,220,225,230,235,240,245,251,256,261,267,272,277,282,287,293,299,304,310,315,320,325,330,335,341,348,353,358,363,368,373,378],{"title":84,"path":80,"stem":81,"restApiVersion":15,"category":15,"description":85,"badge":15},"Introduction","Overview of SDK capabilities for working with Bitrix24 REST API",{"title":87,"path":88,"stem":89,"restApiVersion":90,"category":91,"description":92,"badge":15},"Call","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F1.call-rest-api-ver2","rest-api-ver2","actions","A method for making Bitrix24 REST API version 2 calls.",{"title":87,"path":94,"stem":95,"restApiVersion":96,"category":91,"description":97,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F1.call-rest-api-ver3","rest-api-ver3","Method for making Bitrix24 REST API version 3 calls.",{"title":99,"path":100,"stem":101,"restApiVersion":90,"category":91,"description":102,"badge":15},"CallList","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-list-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F2.call-list-rest-api-ver2","Method for quickly retrieving all data from list methods of Bitrix24 REST API version 2.",{"title":99,"path":104,"stem":105,"restApiVersion":96,"category":91,"description":106,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-list-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F2.call-list-rest-api-ver3","Method for quickly retrieving all data from list methods of Bitrix24 REST API version 3.",{"title":108,"path":109,"stem":110,"restApiVersion":90,"category":91,"description":111,"badge":15},"FetchList","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffetch-list-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F2.fetch-list-rest-api-ver2","Returns an AsyncGenerator that allows processing data from list methods of Bitrix24 REST API version 2 as it is received without loading the entire array into memory at once. This is especially useful when working with very large volumes of data.",{"title":108,"path":113,"stem":114,"restApiVersion":96,"category":91,"description":115,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffetch-list-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F2.fetch-list-rest-api-ver3","Returns an AsyncGenerator that allows processing data from list methods of Bitrix24 REST API version 3 as it is received without loading the entire array into memory at once. This is especially useful when working with very large volumes of data.",{"title":117,"path":118,"stem":119,"restApiVersion":15,"category":117,"description":120,"badge":15},"B24Hook","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhook","docs\u002F2.working-with-the-rest-api\u002F20.hook","Server-side entry point for talking to the Bitrix24 REST API through an inbound webhook (permanent token).",{"title":122,"path":123,"stem":124,"restApiVersion":90,"category":91,"description":125,"badge":15},"Batch","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F3.batch-rest-api-ver2","Method for executing batch requests to Bitrix24 REST API version 2. Allows executing up to 50 commands in a single API call.",{"title":122,"path":127,"stem":128,"restApiVersion":96,"category":91,"description":129,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F3.batch-rest-api-ver3","Method for executing batch requests to Bitrix24 REST API version 3. Allows executing up to 50 commands in a single API call.",{"title":84,"path":131,"stem":132,"restApiVersion":15,"category":133,"description":134,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe","docs\u002F2.working-with-the-rest-api\u002F30.frame","B24Frame","Designed for managing Bitrix24 applications running inside a placement iframe. Inherits from AbstractB24 and exposes managers for authentication, parent-window messaging, sliders, dialogs, placements, and options.",{"title":136,"path":137,"stem":138,"restApiVersion":15,"category":133,"description":139,"badge":15},"Initialization","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-initialize-b24-frame","docs\u002F2.working-with-the-rest-api\u002F30.frame-initialize-b24-frame","Function is designed to initialize a B24Frame",{"title":141,"path":142,"stem":143,"restApiVersion":15,"category":133,"description":144,"badge":15},"Auth","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-auth","docs\u002F2.working-with-the-rest-api\u002F31.frame-auth","Designed for managing authentication in Bitrix24 applications. It handles authentication data received from the parent window and provides methods for updating and retrieving this data.",{"title":146,"path":147,"stem":148,"restApiVersion":15,"category":133,"description":149,"badge":15},"Dialog","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-dialog","docs\u002F2.working-with-the-rest-api\u002F31.frame-dialog","Wraps the BX24 system dialogs (user picker, access permission picker, CRM entity picker) so they can be opened from inside a Bitrix24 application iframe.",{"title":151,"path":152,"stem":153,"restApiVersion":15,"category":133,"description":154,"badge":15},"Options","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-options","docs\u002F2.working-with-the-rest-api\u002F31.frame-options","Used for managing application and user settings in the Bitrix24 application. It allows initializing data, getting, and setting options through messages to the parent window.",{"title":156,"path":157,"stem":158,"restApiVersion":15,"category":133,"description":159,"badge":15},"Parent","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-parent","docs\u002F2.working-with-the-rest-api\u002F31.frame-parent","Provides methods for managing the parent application window in Bitrix24, including resizing the window, managing scroll, initiating calls, and opening the messenger.",{"title":161,"path":162,"stem":163,"restApiVersion":15,"category":133,"description":164,"badge":15},"Placement","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-placement","docs\u002F2.working-with-the-rest-api\u002F31.frame-placement","Used for managing the placement of widgets in the Bitrix24 application.",{"title":166,"path":167,"stem":168,"restApiVersion":15,"category":133,"description":169,"badge":15},"Slider","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-slider","docs\u002F2.working-with-the-rest-api\u002F31.frame-slider","Provides methods for working with sliders in the Bitrix24 application. It allows opening and closing sliders, as well as managing their content.",{"title":171,"path":172,"stem":173,"restApiVersion":90,"category":91,"description":174,"badge":15},"BatchByChunk","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-by-chunk-rest-api-ver2","docs\u002F2.working-with-the-rest-api\u002F4.batch-by-chunk-rest-api-ver2","Method for executing batch requests with automatic chunking for any number of commands. Automatically splits large command sets into batches of 50 and executes them sequentially. Use only arrays of tuples or arrays of objects.",{"title":171,"path":176,"stem":177,"restApiVersion":96,"category":91,"description":178,"badge":15},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-by-chunk-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F4.batch-by-chunk-rest-api-ver3","Method for executing batch requests to Bitrix24 REST API version 3 with automatic chunking for any number of commands. Automatically splits large command sets into batches of 50 and executes them sequentially. Use only arrays of tuples or arrays of objects.",{"title":180,"path":181,"stem":182,"restApiVersion":15,"category":180,"description":183,"badge":15},"B24OAuth","\u002Fdocs\u002Fworking-with-the-rest-api\u002Foauth","docs\u002F2.working-with-the-rest-api\u002F40.oauth","Server-side entry point for talking to the Bitrix24 REST API with an OAuth 2.0 access token (and automatic refresh).",{"title":185,"path":186,"stem":187,"restApiVersion":15,"category":15,"description":188,"badge":15},"Choosing the method","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fchoosing-the-right-method","docs\u002F2.working-with-the-rest-api\u002F5.choosing-the-right-method","Decision guide for picking between Call, CallList, FetchList, Batch and BatchByChunk in REST API v2 and v3.",{"title":190,"path":191,"stem":192,"restApiVersion":15,"category":15,"description":193,"badge":15},"Filtering","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffiltering","docs\u002F2.working-with-the-rest-api\u002F5.filtering","Reference for building filter parameters in Bitrix24 REST API v2 (prefix operators) and v3 (array-of-triples), including date formatting and the order-stripping rule.",{"title":195,"path":196,"stem":197,"restApiVersion":15,"category":198,"description":199,"badge":15},"B24HelperManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper","docs\u002F2.working-with-the-rest-api\u002F50.helper","Helper","Aggregate manager that loads profile, app, payment, license, currency, and options data with one batched REST call, plus wires the Pull client.",{"title":201,"path":202,"stem":203,"restApiVersion":15,"category":198,"description":204,"badge":15},"useB24Helper","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-use-b24-helper","docs\u002F2.working-with-the-rest-api\u002F51.helper-use-b24-helper","Closure-based composable that owns a single B24HelperManager instance and exposes lifecycle helpers (init \u002F destroy \u002F Pull client glue).",{"title":206,"path":207,"stem":208,"restApiVersion":15,"category":198,"description":209,"badge":15},"ProfileManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-profile-manager","docs\u002F2.working-with-the-rest-api\u002F52.helper-profile-manager","Parsed `profile` REST response: id, name, last name, gender, photo, time zone, admin flag.",{"title":211,"path":212,"stem":213,"restApiVersion":15,"category":198,"description":214,"badge":15},"AppManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-app-manager","docs\u002F2.working-with-the-rest-api\u002F53.helper-app-manager","Parsed `app.info` REST response: app id, code, version, status, install flag.",{"title":216,"path":217,"stem":218,"restApiVersion":15,"category":198,"description":219,"badge":15},"PaymentManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-payment-manager","docs\u002F2.working-with-the-rest-api\u002F54.helper-payment-manager","Payment status of a Bitrix24 application — extracted from `app.info`.",{"title":221,"path":222,"stem":223,"restApiVersion":15,"category":198,"description":224,"badge":15},"LicenseManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-license-manager","docs\u002F2.working-with-the-rest-api\u002F55.helper-license-manager","Bitrix24 license info from `app.info` — and an automatic restriction-manager retune for the matching tariff plan.",{"title":226,"path":227,"stem":228,"restApiVersion":15,"category":198,"description":229,"badge":15},"CurrencyManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-currency-manager","docs\u002F2.working-with-the-rest-api\u002F56.helper-currency-manager","Currency catalogue cached in memory — base currency, per-currency formatters, and number-to-string formatter.",{"title":231,"path":232,"stem":233,"restApiVersion":15,"category":198,"description":234,"badge":15},"OptionsManager","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-options-manager","docs\u002F2.working-with-the-rest-api\u002F57.helper-options-manager","Typed access to `app.option.get` \u002F `user.option.get`, plus a save() that batches `*.option.set` with an optional Pull notification.",{"title":236,"path":237,"stem":238,"restApiVersion":15,"category":15,"description":239,"badge":15},"Errors","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ferrors","docs\u002F2.working-with-the-rest-api\u002F6.errors","Reference for SdkError and AjaxError codes raised by the SDK, plus the Bitrix24 REST error codes that surface through them.",{"title":241,"path":242,"stem":243,"restApiVersion":15,"category":241,"description":244,"badge":15},"Pull","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fpull","docs\u002F2.working-with-the-rest-api\u002F60.pull","Real-time message stream from Bitrix24 to your application — WebSocket primary, long-polling fallback. Frame-only.",{"title":246,"path":247,"stem":248,"restApiVersion":15,"category":249,"description":250,"badge":15},"Logger","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogger","docs\u002F2.working-with-the-rest-api\u002F66.logger","logger","Logger inspired by PHP Monolog, provides a structured logging system with support for channels, handlers, processors, and formatters. Implementation follows PSR-3 principles and the chain of responsibility pattern.",{"title":252,"path":253,"stem":254,"restApiVersion":15,"category":249,"description":255,"badge":15},"Telegram","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogger-telegram","docs\u002F2.working-with-the-rest-api\u002F66.logger-telegram","Sending logs to Telegram",{"title":257,"path":258,"stem":259,"restApiVersion":15,"category":15,"description":260,"badge":15},"Discovering v3 methods","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fdiscovering-v3-methods","docs\u002F2.working-with-the-rest-api\u002F7.discovering-v3-methods","Use rest.documentation.openapi to fetch the portal's own machine-readable list of every available REST API v3 method — the source of truth the SDK relies on instead of a hardcoded allowlist. Especially useful for AI agents and codegen.",{"title":262,"path":263,"stem":264,"restApiVersion":15,"category":265,"description":266,"badge":15},"AjaxResult","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-ajax-result","docs\u002F2.working-with-the-rest-api\u002F70.core-ajax-result","Core","Specialised Result returned by every REST helper. Provides `isMore() \u002F getNext() \u002F getTotal() \u002F getStatus()` for paged responses, and immutable data.",{"title":268,"path":269,"stem":270,"restApiVersion":15,"category":265,"description":271,"badge":15},"Http","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-http","docs\u002F2.working-with-the-rest-api\u002F70.core-http","Low-level transport interface returned by `b24.getHttpClient(version)`. Direct access to the axios-based clients, restriction params, statistics, and reset.",{"title":273,"path":274,"stem":275,"restApiVersion":15,"category":265,"description":276,"badge":15},"B24LangList","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-lang-list","docs\u002F2.working-with-the-rest-api\u002F70.core-lang-list","Enum of Bitrix24 cloud interface languages plus the BCP-47 locale map.",{"title":278,"path":279,"stem":280,"restApiVersion":15,"category":265,"description":281,"badge":15},"RequestIdGenerator","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-request-id-generator","docs\u002F2.working-with-the-rest-api\u002F70.core-request-id-generator","Default `IRequestIdGenerator` implementation. Generates UUID v7 request ids and exposes the header \u002F query parameter names used by the SDK.",{"title":283,"path":284,"stem":285,"restApiVersion":15,"category":265,"description":286,"badge":15},"Result","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-result","docs\u002F2.working-with-the-rest-api\u002F70.core-result","Generic operation result with success flag, data, and an error map. Analogue of \\\\Bitrix\\\\Main\\\\Result from the Bitrix Framework.",{"title":288,"path":289,"stem":290,"restApiVersion":15,"category":291,"description":292,"badge":15},"Limiters","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flimiters","docs\u002F2.working-with-the-rest-api\u002F77.limiters","limiters","The restrictions system provides a comprehensive mechanism for managing request frequency, operation execution time, and adaptive delays.",{"title":294,"path":295,"stem":296,"restApiVersion":15,"category":297,"description":298,"badge":15},"Logging & Redaction","\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogging","docs\u002F2.working-with-the-rest-api\u002F78.logging","logging","What the SDK redacts automatically before any request information enters the logger or an AjaxError, what it does not redact, and how to wire a custom logger via setLogger(...) without re-introducing credential leaks.",{"title":300,"path":301,"stem":302,"restApiVersion":15,"category":15,"description":303,"badge":15},"Security","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fsecurity","docs\u002F2.working-with-the-rest-api\u002F79.security","Two hardening patterns for any server that receives Bitrix24 outbound events or OAuth install\u002Funinstall callbacks: reply 200 before you verify, and compare application_token in constant time.",{"title":305,"path":306,"stem":307,"restApiVersion":15,"category":308,"description":309,"badge":15},"Browser","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-browser","docs\u002F2.working-with-the-rest-api\u002F80.tools-browser","tools","Cheap user-agent \u002F platform \u002F capability detector. Useful for runtime branches in front-end code.",{"title":311,"path":312,"stem":313,"restApiVersion":15,"category":308,"description":314,"badge":15},"Environment","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-environment","docs\u002F2.working-with-the-rest-api\u002F80.tools-environment","Runtime environment detection — `getEnvironment()` and the `Environment` enum for branching between browser and Node.js code paths.",{"title":316,"path":317,"stem":318,"restApiVersion":15,"category":308,"description":319,"badge":15},"Object helpers","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-object-helpers","docs\u002F2.working-with-the-rest-api\u002F80.tools-object-helpers","Tiny, dependency-free object and enum helpers — `pick`, `omit`, `getEnumValue`, and the `isArrayOfArray` type guard.",{"title":321,"path":322,"stem":323,"restApiVersion":15,"category":308,"description":324,"badge":15},"Text","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-text","docs\u002F2.working-with-the-rest-api\u002F80.tools-text","Text and date utilities — UUID v4 \u002F v7, encode \u002F decode HTML entities, type conversions, case helpers, Luxon-backed `toDateTime` \u002F `toB24Format`, number formatting, and query-string builder.",{"title":326,"path":327,"stem":328,"restApiVersion":15,"category":308,"description":329,"badge":15},"Type","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-type","docs\u002F2.working-with-the-rest-api\u002F80.tools-type","Runtime type guards — strings, numbers, plain objects, arrays, DOM nodes, Blobs, FormData, JSON-RPC message shapes.",{"title":331,"path":332,"stem":333,"restApiVersion":15,"category":308,"description":334,"badge":15},"useFormatter","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-use-formatters","docs\u002F2.working-with-the-rest-api\u002F80.tools-use-formatters","Composable that returns shared `FormatterNumbers` and `FormatterIban` instances pre-configured with country specifications.",{"title":336,"path":337,"stem":338,"restApiVersion":15,"category":339,"description":340,"badge":15},"Common","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-common","docs\u002F2.working-with-the-rest-api\u002F90.types-common","Types","Foundational building blocks used across the SDK — scalar string aliases, field-metadata shapes (Fields, MultiField, UserFieldType), and the DataType enum.",{"title":342,"path":343,"stem":344,"children":345,"restApiVersion":15,"category":339,"description":347,"badge":15},"Types overview","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-index","docs\u002F2.working-with-the-rest-api\u002F90.types-index",[346],{"title":342,"path":343,"stem":344,"restApiVersion":15,"category":339,"description":347,"badge":15},"Navigable map of every types\u002F* module in the SDK — which have a dedicated page, which are surfaced through another page, and which are follow-ups.",{"title":349,"path":350,"stem":351,"restApiVersion":15,"category":339,"description":352,"badge":15},"IResult","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-iresult","docs\u002F2.working-with-the-rest-api\u002F90.types-iresult","Generic operation-result interface. Implemented by `Result\u003CT>` and (transitively) by `AjaxResult\u003CT>`.",{"title":354,"path":355,"stem":356,"restApiVersion":15,"category":339,"description":357,"badge":15},"Payloads","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-payloads","docs\u002F2.working-with-the-rest-api\u002F90.types-payloads","The REST response envelope — PayloadTime, GetPayload, ListPayload, BatchPayload, SuccessPayload, and the Payload union, with a note on the v2 vs v3 envelope status.",{"title":359,"path":360,"stem":361,"restApiVersion":15,"category":339,"description":362,"badge":15},"TypeB24","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-type-b24","docs\u002F2.working-with-the-rest-api\u002F90.types-type-b24","Public contract implemented by every entry-point class (B24Frame, B24Hook, B24OAuth). Single source of truth for the SDK surface.",{"title":364,"path":365,"stem":366,"restApiVersion":15,"category":265,"description":367,"badge":15},"Telemetry","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftelemetry","docs\u002F2.working-with-the-rest-api\u002F95.telemetry","Request id, SDK version, and SDK type query parameters added to every Bitrix24 REST call.",{"title":369,"path":370,"stem":371,"restApiVersion":15,"category":265,"description":372,"badge":15},"Error Codes","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ferror-codes","docs\u002F2.working-with-the-rest-api\u002F96.error-codes","Catalogue of error codes the SDK recognises — split into \"hard\" (thrown) and \"soft\" (returned as AjaxError inside AjaxResult).",{"title":374,"path":375,"stem":376,"restApiVersion":15,"category":308,"description":377,"badge":15},"HealthCheck","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-health-check","docs\u002F2.working-with-the-rest-api\u002Ftools-health-check","Method for checking the availability of Bitrix24 REST API. Performs a simple request to the REST API to verify service health.",{"title":379,"path":380,"stem":381,"restApiVersion":15,"category":308,"description":382,"badge":15},"Ping","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-ping","docs\u002F2.working-with-the-rest-api\u002Ftools-ping","Method for measuring Bitrix24 REST API response speed. Performs a test request and returns response time in milliseconds.",{"title":384,"path":385,"stem":386,"children":387,"restApiVersion":15,"category":15,"description":15,"badge":15},"API Reference","\u002Fdocs\u002Fapi-reference","docs\u002F3.api-reference\u002F1.index",[388],{"title":384,"path":385,"stem":386,"restApiVersion":15,"category":15,"description":389,"badge":15},"Index of the public @bitrix24\u002Fb24jssdk surface, grouped by domain — every value export, what it is, and where its guide and source live.",{"title":391,"path":392,"stem":393,"children":394,"restApiVersion":15,"category":15,"description":15,"badge":15},"Examples","\u002Fdocs\u002Fexamples","docs\u002F99.examples\u002F0.index",[395,397,403,408,413,418,423,428,433,438,443,448,453,458,463,468,473,478,483,488,493],{"title":84,"path":392,"stem":393,"restApiVersion":15,"category":15,"description":396,"badge":15},"Recipes that pair the SDK with realistic scenarios — CRM analytics, mass messaging, AI assistants, OAuth installs, and more. Each recipe is a single, copy-paste-friendly file.",{"title":398,"path":399,"stem":400,"restApiVersion":15,"category":401,"description":402,"badge":15},"CRM analytics","\u002Fdocs\u002Fexamples\u002Fcrm-analytics","docs\u002F99.examples\u002F1.crm-analytics","examples","Stream all deals via actions.v2.fetchList.make, group by stage, print a funnel report (counts, conversion %, avg ticket, win rate).",{"title":404,"path":405,"stem":406,"restApiVersion":15,"category":401,"description":407,"badge":15},"Deals → CSV","\u002Fdocs\u002Fexamples\u002Fdashboard-deals-csv","docs\u002F99.examples\u002F1.dashboard-deals-csv","Stream every CRM deal that matches a date filter into a CSV file using a webhook and FetchListV2.",{"title":409,"path":410,"stem":411,"restApiVersion":15,"category":15,"description":412,"badge":15},"Entity List","\u002Fdocs\u002Fexamples\u002Fentity-list","docs\u002F99.examples\u002F10.entity-list","Render a paged Bitrix24 entity list with B24UI components and the SDK callList action.",{"title":414,"path":415,"stem":416,"restApiVersion":15,"category":401,"description":417,"badge":15},"Error handling","\u002Fdocs\u002Fexamples\u002Ferror-handling","docs\u002F99.examples\u002F10.error-handling","Demonstrates the four error layers (SdkError \u002F AjaxError \u002F network \u002F soft) and the hardErrorCodes \u002F softErrorCodes \u002F retryOnNetworkError knobs on the restriction manager.",{"title":419,"path":420,"stem":421,"restApiVersion":15,"category":401,"description":422,"badge":15},"Event registration","\u002Fdocs\u002Fexamples\u002Fevent-registration","docs\u002F99.examples\u002F11.event-registration","CLI tool — list, bind, and unbind Bitrix24 outbound webhook events via event.get \u002F event.bind \u002F event.unbind. Pairs with the webhook handler recipe.",{"title":424,"path":425,"stem":426,"restApiVersion":15,"category":401,"description":427,"badge":15},"OAuth install","\u002Fdocs\u002Fexamples\u002Foauth-install","docs\u002F99.examples\u002F12.oauth-install","Express server that handles ONAPPINSTALL \u002F ONAPPUPDATE \u002F ONAPPUNINSTALL events for a Bitrix24 marketplace app, persists tokens per portal, and builds a B24OAuth client on demand with a refresh callback wired to storage.",{"title":429,"path":430,"stem":431,"restApiVersion":15,"category":401,"description":432,"badge":15},"Frame app skeleton","\u002Fdocs\u002Fexamples\u002Fframe-app-skeleton","docs\u002F99.examples\u002F2.frame-app-skeleton","Minimum viable Bitrix24 iframe app: init handshake, set title, persist app state, open a slider, close cleanly.",{"title":434,"path":435,"stem":436,"restApiVersion":15,"category":401,"description":437,"badge":15},"Mass messaging","\u002Fdocs\u002Fexamples\u002Fmass-messaging","docs\u002F99.examples\u002F2.mass-messaging","Filter contacts in CRM, personalise a template, send IM notifications to assigned managers.",{"title":439,"path":440,"stem":441,"restApiVersion":15,"category":15,"description":442,"badge":15},"Installation Wizard","\u002Fdocs\u002Fexamples\u002Fapp-installation-wizard","docs\u002F99.examples\u002F20.app-installation-wizard","Multi-step install flow that creates user fields, registers placements, celebrates with confetti, and finalises the installation last — because the portal reloads the page in response.",{"title":444,"path":445,"stem":446,"restApiVersion":15,"category":401,"description":447,"badge":15},"Task automation","\u002Fdocs\u002Fexamples\u002Ftask-automation","docs\u002F99.examples\u002F3.task-automation","Poll deal stages every 60 s. When a watched transition fires, create a task with description, deadline and priority.",{"title":449,"path":450,"stem":451,"restApiVersion":15,"category":401,"description":452,"badge":15},"Webhook CLI","\u002Fdocs\u002Fexamples\u002Fwebhook-cli-node","docs\u002F99.examples\u002F3.webhook-cli-node","A 30-line Node script that authenticates against a Bitrix24 portal via inbound webhook and prints the calling user — useful as the first thing you run after creating a webhook.",{"title":454,"path":455,"stem":456,"restApiVersion":15,"category":15,"description":457,"badge":15},"Node + Hook Export","\u002Fdocs\u002Fexamples\u002Fnode-hook-company-export","docs\u002F99.examples\u002F30.node-hook-company-export","Export Bitrix24 companies into a CSV file from a pure Node.js script using B24Hook.",{"title":459,"path":460,"stem":461,"restApiVersion":15,"category":401,"description":462,"badge":15},"Bulk update","\u002Fdocs\u002Fexamples\u002Fbulk-update-deals","docs\u002F99.examples\u002F4.bulk-update-deals","Migrate thousands of CRM deals to a new stage using BatchByChunkV2 — automatic chunking, partial-error handling, and a single progress line.",{"title":464,"path":465,"stem":466,"restApiVersion":15,"category":401,"description":467,"badge":15},"ERP sync","\u002Fdocs\u002Fexamples\u002Ferp-sync","docs\u002F99.examples\u002F4.erp-sync","Two-way contact sync between Bitrix24 and an external ERP. Match by INN (primary) or email (fallback). Cron every hour.",{"title":469,"path":470,"stem":471,"restApiVersion":15,"category":401,"description":472,"badge":15},"Disk files","\u002Fdocs\u002Fexamples\u002Fdisk-files","docs\u002F99.examples\u002F5.disk-files","List storages and folder children, create subfolders, inspect files. File upload (multipart) is intentionally out of scope.",{"title":474,"path":475,"stem":476,"restApiVersion":15,"category":401,"description":477,"badge":15},"Pull subscribe","\u002Fdocs\u002Fexamples\u002Fpull-subscribe-frame","docs\u002F99.examples\u002F5.pull-subscribe-frame","Open a live channel from a Bitrix24 frame app and react to push events using useB24Helper + the Pull client.",{"title":479,"path":480,"stem":481,"restApiVersion":15,"category":401,"description":482,"badge":15},"Telegram bot","\u002Fdocs\u002Fexamples\u002Ftelegram-bot","docs\u002F99.examples\u002F6.telegram-bot","Poll new CRM deals every two minutes; notify a Telegram chat with an HTML-formatted card.",{"title":484,"path":485,"stem":486,"restApiVersion":15,"category":401,"description":487,"badge":15},"Webhook handler","\u002Fdocs\u002Fexamples\u002Fwebhook-handler","docs\u002F99.examples\u002F7.webhook-handler","Express server that receives Bitrix24 outbound events, fetches details via REST, dispatches by event name. Always returns 200.",{"title":489,"path":490,"stem":491,"restApiVersion":15,"category":401,"description":492,"badge":15},"AI assistant","\u002Fdocs\u002Fexamples\u002Fai-assistant","docs\u002F99.examples\u002F8.ai-assistant","Load a deal and its activities, ask GPT-4o for the next-best action, create a task bound to the deal with priority and deadline.",{"title":494,"path":495,"stem":496,"restApiVersion":15,"category":401,"description":497,"badge":15},"Web search + LLM","\u002Fdocs\u002Fexamples\u002Fweb-search-llm","docs\u002F99.examples\u002F9.web-search-llm","Two-step RAG: ask any web-search provider, run the result through your LLM with [N] citations, post the answer as a CRM timeline comment on a deal.",{"id":499,"title":384,"audited":500,"badge":15,"body":501,"category":15,"cookbookOrder":15,"description":389,"extension":2397,"featured":47,"links":2398,"meta":2403,"navigation":2404,"path":385,"restApiVersion":15,"scopes":15,"seo":2405,"stack":15,"stem":386,"__hash__":2406},"docs\u002Fdocs\u002F3.api-reference\u002F1.index.md","2026-08-24",{"type":502,"value":503,"toc":2381},"minimark",[504,531,544,554,559,566,732,736,750,888,892,907,1010,1014,1017,1132,1136,1139,1239,1243,1249,1416,1419,1422,1546,1549,1556,1877,1880,1883,2109,2113,2116,2246,2250,2253,2315,2319,2322,2378],[505,506,507,508,512,513,517,518,521,522,525,526,530],"p",{},"This is the index of every ",[509,510,511],"strong",{},"value"," ",[514,515,516],"code",{},"@bitrix24\u002Fb24jssdk"," exports publicly — the classes, enums, constants and functions you can import and use at runtime — grouped by domain. Each entry says what the export is and links to its guide and its source. Pure ",[514,519,520],{},"type"," and ",[514,523,524],{},"interface"," exports are not listed here; they have their own page, the ",[527,528,342],"a",{"href":529},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-index\u002F",".",[505,532,533,534,537,538,530],{},"It deliberately does ",[509,535,536],{},"not"," restate signatures and parameter tables: those live in the guides, where they are audited against the source and their snippets are compiled in CI. This page is the map, not the territory. Per-symbol reference pages are a separate, later layer — tracked in ",[527,539,543],{"href":540,"rel":541},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fissues\u002F315",[542],"nofollow","#315",[545,546,547],"note",{},[505,548,549,550,553],{},"New here? Start with ",[527,551,10],{"href":552},"\u002Fdocs\u002Fgetting-started\u002F"," and pick an entry point below — that choice determines everything else.",[555,556,558],"h2",{"id":557},"entry-points","Entry points",[505,560,561,562,565],{},"Pick by ",[509,563,564],{},"where your code runs"," — this is the first decision, and everything else follows from it.",[567,568,569,585],"table",{},[570,571,572],"thead",{},[573,574,575,579,582],"tr",{},[576,577,578],"th",{},"Export",[576,580,581],{},"What it is",[576,583,584],{},"Guide",[586,587,588,608,626,648,669,692,712],"tbody",{},[573,589,590,599,602],{},[591,592,593],"td",{},[527,594,597],{"href":595,"rel":596},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fhook\u002Fb24.ts",[542],[514,598,117],{},[591,600,601],{},"Server-side webhook auth. Carries a long-lived secret — never ship it to a browser.",[591,603,604],{},[527,605,607],{"href":606},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhook\u002F","guide",[573,609,610,618,621],{},[591,611,612],{},[527,613,616],{"href":614,"rel":615},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Fb24.ts",[542],[514,617,133],{},[591,619,620],{},"An app running inside a Bitrix24 placement iframe.",[591,622,623],{},[527,624,607],{"href":625},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe\u002F",[573,627,628,637,643],{},[591,629,630],{},[527,631,634],{"href":632,"rel":633},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Floader-b24frame.ts",[542],[514,635,636],{},"initializeB24Frame",[591,638,639,640,642],{},"The only correct way to construct a ",[514,641,133],{}," — performs the parent handshake.",[591,644,645],{},[527,646,607],{"href":647},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-initialize-b24-frame\u002F",[573,649,650,658,664],{},[591,651,652],{},[527,653,656],{"href":654,"rel":655},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Foauth\u002Fb24.ts",[542],[514,657,180],{},[591,659,660,661,663],{},"A marketplace\u002FOAuth app, authenticated per portal with a refresh token. Server-side only, like ",[514,662,117],{}," — never ship the client secret to a browser.",[591,665,666],{},[527,667,607],{"href":668},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Foauth\u002F",[573,670,671,680,687],{},[591,672,673],{},[527,674,677],{"href":675,"rel":676},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fabstract-b24.ts",[542],[514,678,679],{},"AbstractB24",[591,681,682,683,686],{},"The shared base the three entry points extend — where the deprecated ",[514,684,685],{},"b24.callMethod()","-style shortcuts live.",[591,688,689],{},[527,690,607],{"href":691},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fchoosing-the-right-method\u002F",[573,693,694,703,708],{},[591,695,696],{},[527,697,700],{"href":698,"rel":699},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fhook\u002Fauth.ts",[542],[514,701,702],{},"AuthHookManager",[591,704,705,706,530],{},"Auth actions behind ",[514,707,117],{},[591,709,710],{},[527,711,607],{"href":606},[573,713,714,723,728],{},[591,715,716],{},[527,717,720],{"href":718,"rel":719},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Foauth\u002Fauth.ts",[542],[514,721,722],{},"AuthOAuthManager",[591,724,705,725,727],{},[514,726,180],{},", including token refresh.",[591,729,730],{},[527,731,607],{"href":668},[555,733,735],{"id":734},"actions-calling-the-rest-api","Actions — calling the REST API",[505,737,738,739,742,743,521,746,749],{},"The ",[514,740,741],{},"$b24.actions.v{2,3}.*"," surface. ",[514,744,745],{},"v2",[514,747,748],{},"v3"," are different dialects, not versions of one thing.",[567,751,752,762],{},[570,753,754],{},[573,755,756,758,760],{},[576,757,578],{},[576,759,581],{},[576,761,584],{},[586,763,764,781,807,826,844,863],{},[573,765,766,775,778],{},[591,767,768],{},[527,769,772],{"href":770,"rel":771},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fversion-manager.ts",[542],[514,773,774],{},"versionManager",[591,776,777],{},"Routes a method to the v2 or v3 transport.",[591,779,780],{},"—",[573,782,783,792,802],{},[591,784,785],{},[527,786,789],{"href":787,"rel":788},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fb24.ts",[542],[514,790,791],{},"ApiVersion",[591,793,738,794,797,798,801],{},[514,795,796],{},"restApi:v2"," \u002F ",[514,799,800],{},"restApi:v3"," discriminator.",[591,803,804],{},[527,805,607],{"href":806},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Flimiters\u002F",[573,808,809,818,821],{},[591,810,811],{},[527,812,815],{"href":813,"rel":814},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Fv2.ts",[542],[514,816,817],{},"HttpV2",[591,819,820],{},"The v2 transport.",[591,822,823],{},[527,824,607],{"href":825},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-http\u002F",[573,827,828,837,840],{},[591,829,830],{},[527,831,834],{"href":832,"rel":833},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Fv3.ts",[542],[514,835,836],{},"HttpV3",[591,838,839],{},"The v3 transport.",[591,841,842],{},[527,843,607],{"href":825},[573,845,846,855,858],{},[591,847,848],{},[527,849,852],{"href":850,"rel":851},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Ffilter-v3.ts",[542],[514,853,854],{},"FilterV3",[591,856,857],{},"Typed builder for the v3 array-of-triples filter grammar.",[591,859,860],{},[527,861,607],{"href":862},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffiltering\u002F",[573,864,865,874,883],{},[591,866,867],{},[527,868,871],{"href":869,"rel":870},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Fbatch-ref-v3.ts",[542],[514,872,873],{},"BatchRefV3",[591,875,876,797,879,882],{},[514,877,878],{},"$ref",[514,880,881],{},"$refArray"," markers for v3 batch cross-command substitution.",[591,884,885],{},[527,886,607],{"href":887},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-rest-api-ver3\u002F",[555,889,891],{"id":890},"results-and-errors","Results and errors",[505,893,894,895,897,898,902,903,906],{},"Every call returns a ",[514,896,283],{},"; failures split into ",[899,900,901],"em",{},"soft"," (returned) and ",[899,904,905],{},"hard"," (thrown).",[567,908,909,919],{},[570,910,911],{},[573,912,913,915,917],{},[576,914,578],{},[576,916,581],{},[576,918,584],{},[586,920,921,949,967,989],{},[573,922,923,931,944],{},[591,924,925],{},[527,926,929],{"href":927,"rel":928},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Fajax-result.ts",[542],[514,930,262],{},[591,932,933,934,937,938,937,941,530],{},"The response wrapper — ",[514,935,936],{},"isSuccess",", ",[514,939,940],{},"getData()",[514,942,943],{},"getErrorMessages()",[591,945,946],{},[527,947,607],{"href":948},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-ajax-result\u002F",[573,950,951,959,962],{},[591,952,953],{},[527,954,957],{"href":955,"rel":956},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fresult.ts",[542],[514,958,283],{},[591,960,961],{},"The base result type.",[591,963,964],{},[527,965,607],{"href":966},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-result\u002F",[573,968,969,978,984],{},[591,970,971],{},[527,972,975],{"href":973,"rel":974},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Fajax-error.ts",[542],[514,976,977],{},"AjaxError",[591,979,980,981,530],{},"A transport-level error, with credentials redacted from ",[514,982,983],{},"requestInfo",[591,985,986],{},[527,987,607],{"href":988},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ferrors\u002F",[573,990,991,1000,1006],{},[591,992,993],{},[527,994,997],{"href":995,"rel":996},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fsdk-error.ts",[542],[514,998,999],{},"SdkError",[591,1001,1002,1003,1005],{},"An SDK error carrying a stable ",[514,1004,514],{}," to discriminate on.",[591,1007,1008],{},[527,1009,607],{"href":988},[555,1011,1013],{"id":1012},"rate-limiting","Rate limiting",[505,1015,1016],{},"The limiter stack that keeps the SDK inside the portal's request budget.",[567,1018,1019,1029],{},[570,1020,1021],{},[573,1022,1023,1025,1027],{},[576,1024,578],{},[576,1026,581],{},[576,1028,584],{},[586,1030,1031,1049,1074,1092,1114],{},[573,1032,1033,1042,1045],{},[591,1034,1035],{},[527,1036,1039],{"href":1037,"rel":1038},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Flimiters\u002Fmanager.ts",[542],[514,1040,1041],{},"RestrictionManager",[591,1043,1044],{},"Owns the limiter stack and the retry policy.",[591,1046,1047],{},[527,1048,607],{"href":806},[573,1050,1051,1060,1070],{},[591,1052,1053],{},[527,1054,1057],{"href":1055,"rel":1056},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Flimiters\u002Fparams-factory.ts",[542],[514,1058,1059],{},"ParamsFactory",[591,1061,1062,1063,937,1066,1069],{},"Preset limiter configurations (",[514,1064,1065],{},"getDefault()",[514,1067,1068],{},"getBatchProcessing()",").",[591,1071,1072],{},[527,1073,607],{"href":806},[573,1075,1076,1085,1088],{},[591,1077,1078],{},[527,1079,1082],{"href":1080,"rel":1081},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Flimiters\u002Frate-limiter.ts",[542],[514,1083,1084],{},"RateLimiter",[591,1086,1087],{},"Request-rate limiter.",[591,1089,1090],{},[527,1091,607],{"href":806},[573,1093,1094,1103,1110],{},[591,1095,1096],{},[527,1097,1100],{"href":1098,"rel":1099},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Flimiters\u002Foperating-limiter.ts",[542],[514,1101,1102],{},"OperatingLimiter",[591,1104,1105,1106,1109],{},"Honours the portal's ",[514,1107,1108],{},"operating"," budget.",[591,1111,1112],{},[527,1113,607],{"href":806},[573,1115,1116,1125,1128],{},[591,1117,1118],{},[527,1119,1122],{"href":1120,"rel":1121},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fhttp\u002Flimiters\u002Fadaptive-delayer.ts",[542],[514,1123,1124],{},"AdaptiveDelayer",[591,1126,1127],{},"Backoff between retries.",[591,1129,1130],{},[527,1131,607],{"href":806},[555,1133,1135],{"id":1134},"realtime-pull","Realtime — Pull",[505,1137,1138],{},"Push notifications from the portal.",[567,1140,1141,1151],{},[570,1142,1143],{},[573,1144,1145,1147,1149],{},[576,1146,578],{},[576,1148,581],{},[576,1150,584],{},[586,1152,1153,1172,1190,1207,1224],{},[573,1154,1155,1164,1167],{},[591,1156,1157],{},[527,1158,1161],{"href":1159,"rel":1160},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002FpullClient\u002Findex.ts",[542],[514,1162,1163],{},"B24PullClientManager",[591,1165,1166],{},"The Pull client.",[591,1168,1169],{},[527,1170,607],{"href":1171},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fpull\u002F",[573,1173,1174,1183,1186],{},[591,1175,1176],{},[527,1177,1180],{"href":1178,"rel":1179},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fpull.ts",[542],[514,1181,1182],{},"PullStatus",[591,1184,1185],{},"Connection status values.",[591,1187,1188],{},[527,1189,607],{"href":1171},[573,1191,1192,1200,1203],{},[591,1193,1194],{},[527,1195,1197],{"href":1178,"rel":1196},[542],[514,1198,1199],{},"SubscriptionType",[591,1201,1202],{},"Subscription kinds.",[591,1204,1205],{},[527,1206,607],{"href":1171},[573,1208,1209,1217,1220],{},[591,1210,1211],{},[527,1212,1214],{"href":1178,"rel":1213},[542],[514,1215,1216],{},"ConnectionType",[591,1218,1219],{},"Transport used by the client.",[591,1221,1222],{},[527,1223,607],{"href":1171},[573,1225,1226,1234,1237],{},[591,1227,1228],{},[527,1229,1231],{"href":1178,"rel":1230},[542],[514,1232,1233],{},"CloseReasons",[591,1235,1236],{},"Why a connection closed.",[591,1238,780],{},[555,1240,1242],{"id":1241},"frame-managers","Frame managers",[505,1244,1245,1246,1248],{},"Available on a ",[514,1247,133],{}," instance — the portal-side UI surface.",[567,1250,1251,1261],{},[570,1252,1253],{},[573,1254,1255,1257,1259],{},[576,1256,578],{},[576,1258,581],{},[576,1260,584],{},[586,1262,1263,1285,1307,1329,1351,1372,1394],{},[573,1264,1265,1274,1280],{},[591,1266,1267],{},[527,1268,1271],{"href":1269,"rel":1270},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Fparent.ts",[542],[514,1272,1273],{},"ParentManager",[591,1275,1276,1279],{},[514,1277,1278],{},"$b24.parent"," — control the iframe inside the portal layout.",[591,1281,1282],{},[527,1283,607],{"href":1284},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-parent\u002F",[573,1286,1287,1296,1302],{},[591,1288,1289],{},[527,1290,1293],{"href":1291,"rel":1292},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Fslider.ts",[542],[514,1294,1295],{},"SliderManager",[591,1297,1298,1301],{},[514,1299,1300],{},"$b24.slider"," — open paths and app pages in a slider.",[591,1303,1304],{},[527,1305,607],{"href":1306},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-slider\u002F",[573,1308,1309,1318,1324],{},[591,1310,1311],{},[527,1312,1315],{"href":1313,"rel":1314},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Fplacement.ts",[542],[514,1316,1317],{},"PlacementManager",[591,1319,1320,1323],{},[514,1321,1322],{},"$b24.placement"," — the context the user opened the app from.",[591,1325,1326],{},[527,1327,607],{"href":1328},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-placement\u002F",[573,1330,1331,1340,1346],{},[591,1332,1333],{},[527,1334,1337],{"href":1335,"rel":1336},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Fdialog.ts",[542],[514,1338,1339],{},"DialogManager",[591,1341,1342,1345],{},[514,1343,1344],{},"$b24.dialog"," — pick users, CRM entities, access targets.",[591,1347,1348],{},[527,1349,607],{"href":1350},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-dialog\u002F",[573,1352,1353,1361,1367],{},[591,1354,1355],{},[527,1356,1359],{"href":1357,"rel":1358},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Foptions.ts",[542],[514,1360,231],{},[591,1362,1363,1366],{},[514,1364,1365],{},"$b24.options"," — persist app and per-user settings.",[591,1368,1369],{},[527,1370,607],{"href":1371},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-options\u002F",[573,1373,1374,1383,1389],{},[591,1375,1376],{},[527,1377,1380],{"href":1378,"rel":1379},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Fauth.ts",[542],[514,1381,1382],{},"AuthManager",[591,1384,1385,1388],{},[514,1386,1387],{},"$b24.auth"," — the frame's auth actions.",[591,1390,1391],{},[527,1392,607],{"href":1393},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fframe-auth\u002F",[573,1395,1396,1405,1414],{},[591,1397,1398],{},[527,1399,1402],{"href":1400,"rel":1401},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fframe\u002Fmessage\u002Fcontroller.ts",[542],[514,1403,1404],{},"MessageManager",[591,1406,738,1407,1410,1411,530],{},[514,1408,1409],{},"postMessage"," bridge to the parent window, reachable as ",[514,1412,1413],{},"$b24.parent.message",[591,1415,780],{},[555,1417,198],{"id":1418},"helper",[505,1420,1421],{},"Aggregated portal state — profile, app, licence, currency.",[567,1423,1424,1434],{},[570,1425,1426],{},[573,1427,1428,1430,1432],{},[576,1429,578],{},[576,1431,581],{},[576,1433,584],{},[586,1435,1436,1454,1473,1491,1508,1525],{},[573,1437,1438,1446,1449],{},[591,1439,1440],{},[527,1441,1444],{"href":1442,"rel":1443},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fhelper\u002Fuse-b24-helper.ts",[542],[514,1445,201],{},[591,1447,1448],{},"Composable that initialises and exposes the helper.",[591,1450,1451],{},[527,1452,607],{"href":1453},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-use-b24-helper\u002F",[573,1455,1456,1465,1468],{},[591,1457,1458],{},[527,1459,1462],{"href":1460,"rel":1461},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fb24-helper.ts",[542],[514,1463,1464],{},"LoadDataType",[591,1466,1467],{},"Which data sets the helper loads.",[591,1469,1470],{},[527,1471,607],{"href":1472},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper\u002F",[573,1474,1475,1483,1486],{},[591,1476,1477],{},[527,1478,1480],{"href":1460,"rel":1479},[542],[514,1481,1482],{},"EnumAppStatus",[591,1484,1485],{},"Application status values.",[591,1487,1488],{},[527,1489,607],{"href":1490},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-app-manager\u002F",[573,1492,1493,1501,1504],{},[591,1494,1495],{},[527,1496,1498],{"href":1460,"rel":1497},[542],[514,1499,1500],{},"TypeSpecificUrl",[591,1502,1503],{},"Portal URLs the helper resolves.",[591,1505,1506],{},[527,1507,607],{"href":1472},[573,1509,1510,1518,1521],{},[591,1511,1512],{},[527,1513,1515],{"href":1460,"rel":1514},[542],[514,1516,1517],{},"StatusDescriptions",[591,1519,1520],{},"Human-readable app-status descriptions.",[591,1522,1523],{},[527,1524,607],{"href":1490},[573,1526,1527,1535,1541],{},[591,1528,1529],{},[527,1530,1532],{"href":1460,"rel":1531},[542],[514,1533,1534],{},"TypeOption",[591,1536,1537,1538,1540],{},"The value-type discriminator ",[514,1539,1365],{}," stores settings under.",[591,1542,1543],{},[527,1544,607],{"href":1545},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fhelper-options-manager\u002F",[555,1547,1548],{"id":297},"Logging",[505,1550,1551,1552,1555],{},"Monolog-style logging. ",[514,1553,1554],{},"Logger.log()"," never throws and never rejects.",[567,1557,1558,1568],{},[570,1559,1560],{},[573,1561,1562,1564,1566],{},[576,1563,578],{},[576,1565,581],{},[576,1567,584],{},[586,1569,1570,1589,1606,1624,1642,1660,1678,1696,1714,1732,1751,1769,1787,1805,1823,1841,1859],{},[573,1571,1572,1581,1584],{},[591,1573,1574],{},[527,1575,1578],{"href":1576,"rel":1577},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Flogger-factory.ts",[542],[514,1579,1580],{},"LoggerFactory",[591,1582,1583],{},"Build a configured logger — start here.",[591,1585,1586],{},[527,1587,607],{"href":1588},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogger\u002F",[573,1590,1591,1599,1602],{},[591,1592,1593],{},[527,1594,1597],{"href":1595,"rel":1596},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Flogger.ts",[542],[514,1598,246],{},[591,1600,1601],{},"The logger implementation.",[591,1603,1604],{},[527,1605,607],{"href":1588},[573,1607,1608,1617,1620],{},[591,1609,1610],{},[527,1611,1614],{"href":1612,"rel":1613},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fabstract-logger.ts",[542],[514,1615,1616],{},"AbstractLogger",[591,1618,1619],{},"Base class implementing the level convenience methods.",[591,1621,1622],{},[527,1623,607],{"href":1588},[573,1625,1626,1635,1638],{},[591,1627,1628],{},[527,1629,1632],{"href":1630,"rel":1631},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fnull-logger.ts",[542],[514,1633,1634],{},"NullLogger",[591,1636,1637],{},"No-op logger; the SDK's default.",[591,1639,1640],{},[527,1641,607],{"href":1588},[573,1643,1644,1653,1656],{},[591,1645,1646],{},[527,1647,1650],{"href":1648,"rel":1649},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Flogger.ts",[542],[514,1651,1652],{},"LogLevel",[591,1654,1655],{},"Severity levels, DEBUG through EMERGENCY.",[591,1657,1658],{},[527,1659,607],{"href":1588},[573,1661,1662,1671,1674],{},[591,1663,1664],{},[527,1665,1668],{"href":1666,"rel":1667},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fhandler\u002Fconsole-handler.ts",[542],[514,1669,1670],{},"ConsoleHandler",[591,1672,1673],{},"Writes to the browser console.",[591,1675,1676],{},[527,1677,607],{"href":1588},[573,1679,1680,1689,1692],{},[591,1681,1682],{},[527,1683,1686],{"href":1684,"rel":1685},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fhandler\u002Fconsole-v2-handler.ts",[542],[514,1687,1688],{},"ConsoleV2Handler",[591,1690,1691],{},"Improved console handler.",[591,1693,1694],{},[527,1695,607],{"href":1588},[573,1697,1698,1707,1710],{},[591,1699,1700],{},[527,1701,1704],{"href":1702,"rel":1703},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fhandler\u002Fmemory-handler.ts",[542],[514,1705,1706],{},"MemoryHandler",[591,1708,1709],{},"Keeps records in memory — useful in tests.",[591,1711,1712],{},[527,1713,607],{"href":1588},[573,1715,1716,1725,1728],{},[591,1717,1718],{},[527,1719,1722],{"href":1720,"rel":1721},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fhandler\u002Fstream-handler.ts",[542],[514,1723,1724],{},"StreamHandler",[591,1726,1727],{},"Writes to a Node stream.",[591,1729,1730],{},[527,1731,607],{"href":1588},[573,1733,1734,1743,1746],{},[591,1735,1736],{},[527,1737,1740],{"href":1738,"rel":1739},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fhandler\u002Ftelegram-handler.ts",[542],[514,1741,1742],{},"TelegramHandler",[591,1744,1745],{},"Sends records to a Telegram chat.",[591,1747,1748],{},[527,1749,607],{"href":1750},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Flogger-telegram\u002F",[573,1752,1753,1762,1765],{},[591,1754,1755],{},[527,1756,1759],{"href":1757,"rel":1758},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fhandler\u002Fconsola-adapter.ts",[542],[514,1760,1761],{},"ConsolaAdapter",[591,1763,1764],{},"Bridges to Consola.",[591,1766,1767],{},[527,1768,607],{"href":1588},[573,1770,1771,1780,1783],{},[591,1772,1773],{},[527,1774,1777],{"href":1775,"rel":1776},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fhandler\u002Fwinston-adapter.ts",[542],[514,1778,1779],{},"WinstonAdapter",[591,1781,1782],{},"Bridges to Winston.",[591,1784,1785],{},[527,1786,607],{"href":1588},[573,1788,1789,1798,1801],{},[591,1790,1791],{},[527,1792,1795],{"href":1793,"rel":1794},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fformatter\u002Fline-formatter.ts",[542],[514,1796,1797],{},"LineFormatter",[591,1799,1800],{},"Formats a record as a line.",[591,1802,1803],{},[527,1804,607],{"href":1588},[573,1806,1807,1816,1819],{},[591,1808,1809],{},[527,1810,1813],{"href":1811,"rel":1812},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fformatter\u002Fjson-formatter.ts",[542],[514,1814,1815],{},"JsonFormatter",[591,1817,1818],{},"Formats a record as JSON.",[591,1820,1821],{},[527,1822,607],{"href":1588},[573,1824,1825,1834,1837],{},[591,1826,1827],{},[527,1828,1831],{"href":1829,"rel":1830},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fformatter\u002Ftelegram-formatter.ts",[542],[514,1832,1833],{},"TelegramFormatter",[591,1835,1836],{},"Formats a record for Telegram HTML.",[591,1838,1839],{},[527,1840,607],{"href":1750},[573,1842,1843,1852,1855],{},[591,1844,1845],{},[527,1846,1849],{"href":1847,"rel":1848},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fprocessor\u002Fmemory-usage-processor.ts",[542],[514,1850,1851],{},"memoryUsageProcessor",[591,1853,1854],{},"Adds memory usage to a record.",[591,1856,1857],{},[527,1858,607],{"href":1588},[573,1860,1861,1870,1873],{},[591,1862,1863],{},[527,1864,1867],{"href":1865,"rel":1866},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Flogger\u002Fprocessor\u002Fpid-processor.ts",[542],[514,1868,1869],{},"pidProcessor",[591,1871,1872],{},"Adds the process id to a record.",[591,1874,1875],{},[527,1876,607],{"href":1588},[555,1878,1879],{"id":308},"Tools",[505,1881,1882],{},"Small utilities the SDK uses and re-exports.",[567,1884,1885,1895],{},[570,1886,1887],{},[573,1888,1889,1891,1893],{},[576,1890,578],{},[576,1892,581],{},[576,1894,584],{},[586,1896,1897,1915,1933,1951,1969,1987,2004,2023,2040,2057,2074,2092],{},[573,1898,1899,1907,1910],{},[591,1900,1901],{},[527,1902,1905],{"href":1903,"rel":1904},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Ftype.ts",[542],[514,1906,326],{},[591,1908,1909],{},"Runtime type guards.",[591,1911,1912],{},[527,1913,607],{"href":1914},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-type\u002F",[573,1916,1917,1925,1928],{},[591,1918,1919],{},[527,1920,1923],{"href":1921,"rel":1922},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Ftext.ts",[542],[514,1924,321],{},[591,1926,1927],{},"String, id and date helpers.",[591,1929,1930],{},[527,1931,607],{"href":1932},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-text\u002F",[573,1934,1935,1943,1946],{},[591,1936,1937],{},[527,1938,1941],{"href":1939,"rel":1940},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Fbrowser.ts",[542],[514,1942,305],{},[591,1944,1945],{},"Browser and platform detection.",[591,1947,1948],{},[527,1949,607],{"href":1950},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-browser\u002F",[573,1952,1953,1961,1964],{},[591,1954,1955],{},[527,1956,1959],{"href":1957,"rel":1958},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Fuse-formatters.ts",[542],[514,1960,331],{},[591,1962,1963],{},"Number and date formatting.",[591,1965,1966],{},[527,1967,607],{"href":1968},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-use-formatters\u002F",[573,1970,1971,1979,1982],{},[591,1972,1973],{},[527,1974,1977],{"href":1975,"rel":1976},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Fenvironment.ts",[542],[514,1978,311],{},[591,1980,1981],{},"Where the code is running.",[591,1983,1984],{},[527,1985,607],{"href":1986},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-environment\u002F",[573,1988,1989,1997,2000],{},[591,1990,1991],{},[527,1992,1994],{"href":1975,"rel":1993},[542],[514,1995,1996],{},"getEnvironment",[591,1998,1999],{},"Resolve the current environment.",[591,2001,2002],{},[527,2003,607],{"href":1986},[573,2005,2006,2015,2018],{},[591,2007,2008],{},[527,2009,2012],{"href":2010,"rel":2011},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftools\u002Findex.ts",[542],[514,2013,2014],{},"omit",[591,2016,2017],{},"Object helper — drop keys.",[591,2019,2020],{},[527,2021,607],{"href":2022},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftools-object-helpers\u002F",[573,2024,2025,2033,2036],{},[591,2026,2027],{},[527,2028,2030],{"href":2010,"rel":2029},[542],[514,2031,2032],{},"pick",[591,2034,2035],{},"Object helper — keep keys.",[591,2037,2038],{},[527,2039,607],{"href":2022},[573,2041,2042,2050,2053],{},[591,2043,2044],{},[527,2045,2047],{"href":2010,"rel":2046},[542],[514,2048,2049],{},"isArrayOfArray",[591,2051,2052],{},"Array shape guard.",[591,2054,2055],{},[527,2056,607],{"href":2022},[573,2058,2059,2067,2070],{},[591,2060,2061],{},[527,2062,2064],{"href":2010,"rel":2063},[542],[514,2065,2066],{},"getEnumValue",[591,2068,2069],{},"Enum lookup helper.",[591,2071,2072],{},[527,2073,607],{"href":2022},[573,2075,2076,2084,2087],{},[591,2077,2078],{},[527,2079,2082],{"href":2080,"rel":2081},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Flanguage\u002Flist.ts",[542],[514,2083,273],{},[591,2085,2086],{},"Supported portal languages.",[591,2088,2089],{},[527,2090,607],{"href":2091},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcore-lang-list\u002F",[573,2093,2094,2102,2105],{},[591,2095,2096],{},[527,2097,2099],{"href":2080,"rel":2098},[542],[514,2100,2101],{},"B24LocaleMap",[591,2103,2104],{},"Locale mapping.",[591,2106,2107],{},[527,2108,607],{"href":2091},[555,2110,2112],{"id":2111},"domain-types","Domain types",[505,2114,2115],{},"Typed shapes for the portal's own entities.",[567,2117,2118,2128],{},[570,2119,2120],{},[573,2121,2122,2124,2126],{},[576,2123,578],{},[576,2125,581],{},[576,2127,584],{},[586,2129,2130,2149,2168,2184,2200,2216,2231],{},[573,2131,2132,2141,2144],{},[591,2133,2134],{},[527,2135,2138],{"href":2136,"rel":2137},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fcrm\u002Fentity-type.ts",[542],[514,2139,2140],{},"EnumCrmEntityTypeId",[591,2142,2143],{},"CRM entity type ids.",[591,2145,2146],{},[527,2147,607],{"href":2148},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fbatch-rest-api-ver2\u002F",[573,2150,2151,2160,2163],{},[591,2152,2153],{},[527,2154,2157],{"href":2155,"rel":2156},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fcommon.ts",[542],[514,2158,2159],{},"DataType",[591,2161,2162],{},"Generic data-type discriminator.",[591,2164,2165],{},[527,2166,607],{"href":2167},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-common\u002F",[573,2169,2170,2179,2182],{},[591,2171,2172],{},[527,2173,2176],{"href":2174,"rel":2175},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fcatalog\u002Findex.ts",[542],[514,2177,2178],{},"CatalogProductType",[591,2180,2181],{},"Catalog product types.",[591,2183,780],{},[573,2185,2186,2195,2198],{},[591,2187,2188],{},[527,2189,2192],{"href":2190,"rel":2191},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fcrm\u002Fproductrow.ts",[542],[514,2193,2194],{},"ProductRowDiscountTypeId",[591,2196,2197],{},"Discount types on a product row.",[591,2199,780],{},[573,2201,2202,2211,2214],{},[591,2203,2204],{},[527,2205,2208],{"href":2206,"rel":2207},"https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Ftypes\u002Fbizproc\u002Findex.ts",[542],[514,2209,2210],{},"EnumBizprocDocumentType",[591,2212,2213],{},"Business-process document types.",[591,2215,780],{},[573,2217,2218,2226,2229],{},[591,2219,2220],{},[527,2221,2223],{"href":2206,"rel":2222},[542],[514,2224,2225],{},"getDocumentType",[591,2227,2228],{},"Build a bizproc document type.",[591,2230,780],{},[573,2232,2233,2241,2244],{},[591,2234,2235],{},[527,2236,2238],{"href":2206,"rel":2237},[542],[514,2239,2240],{},"getDocumentId",[591,2242,2243],{},"Build a bizproc document id.",[591,2245,780],{},[555,2247,2249],{"id":2248},"everything-else","Everything else",[505,2251,2252],{},"Also exported, and reachable from the groups above or from the guides — listed so this page stays a complete index of the public surface:",[505,2254,2255,512,2258,512,2261,512,2264,512,2267,512,2270,512,2273,512,2276,512,2279,512,2282,512,2285,512,2288,512,2291,512,2294,512,2297,512,2300,512,2303,512,2306,512,2309,512,2312],{},[514,2256,2257],{},"AppFrame",[514,2259,2260],{},"CatalogProductImageType",[514,2262,2263],{},"CatalogRoundingRuleType",[514,2265,2266],{},"EnumBitrix24Edition",[514,2268,2269],{},"EnumBizprocBaseType",[514,2271,2272],{},"EnumCrmEntityType",[514,2274,2275],{},"EnumCrmEntityTypeShort",[514,2277,2278],{},"ListRpcError",[514,2280,2281],{},"LoggerBrowser",[514,2283,2284],{},"LoggerType",[514,2286,2287],{},"LsKeys",[514,2289,2290],{},"MessageCommands",[514,2292,2293],{},"RefreshTokenError",[514,2295,2296],{},"RpcMethod",[514,2298,2299],{},"SenderType",[514,2301,2302],{},"ServerMode",[514,2304,2305],{},"SystemCommands",[514,2307,2308],{},"convertBizprocDocumentTypeToCrmEntityTypeId",[514,2310,2311],{},"getDocumentTypeForFilter",[514,2313,2314],{},"getEnumCrmEntityTypeShort",[555,2316,2318],{"id":2317},"not-yet-covered-by-a-guide","Not yet covered by a guide",[505,2320,2321],{},"These exports are public but have no deep-dive page of their own yet. They are\nlisted here rather than quietly omitted, so the gap is a visible, closable list\ninstead of something a reader discovers by failing to find it:",[505,2323,2324,512,2326,512,2328,512,2330,512,2332,512,2334,512,2336,512,2338,512,2340,512,2342,512,2344,512,2346,512,2348,512,2350,512,2352,512,2354,512,2356,512,2358,512,2360,512,2362,512,2364,512,2366,512,2368,512,2370,512,2372,512,2374,512,2376],{},[514,2325,2257],{},[514,2327,2260],{},[514,2329,2178],{},[514,2331,2263],{},[514,2333,1233],{},[514,2335,2266],{},[514,2337,2269],{},[514,2339,2210],{},[514,2341,2272],{},[514,2343,2275],{},[514,2345,2278],{},[514,2347,2281],{},[514,2349,2284],{},[514,2351,2287],{},[514,2353,2290],{},[514,2355,1404],{},[514,2357,2194],{},[514,2359,2296],{},[514,2361,2299],{},[514,2363,2302],{},[514,2365,2305],{},[514,2367,2308],{},[514,2369,2240],{},[514,2371,2225],{},[514,2373,2311],{},[514,2375,2314],{},[514,2377,774],{},[505,2379,2380],{},"Most are enums and type namespaces whose meaning is evident from the source\nlinked above. If you needed one of these and the source was not enough, that is\nworth an issue — it tells us which page to write next.",{"title":2382,"searchDepth":2383,"depth":2383,"links":2384},"",2,[2385,2386,2387,2388,2389,2390,2391,2392,2393,2394,2395,2396],{"id":557,"depth":2383,"text":558},{"id":734,"depth":2383,"text":735},{"id":890,"depth":2383,"text":891},{"id":1012,"depth":2383,"text":1013},{"id":1134,"depth":2383,"text":1135},{"id":1241,"depth":2383,"text":1242},{"id":1418,"depth":2383,"text":198},{"id":297,"depth":2383,"text":1548},{"id":308,"depth":2383,"text":1879},{"id":2111,"depth":2383,"text":2112},{"id":2248,"depth":2383,"text":2249},{"id":2317,"depth":2383,"text":2318},"md",[2399],{"label":2400,"iconName":2401,"to":2402},"index.ts (the public surface)","GitHubIcon","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Findex.ts",{},{"title":384},{"title":384,"description":389},"rrW43eA1WonRxMeHGYPd4sh7IejAOPMWUIcAMB8bABM",{"data":2408,"body":2409},{},{"type":2410,"children":2411},"root",[2412],{"type":2413,"tag":505,"props":2414,"children":2415},"element",{},[2416],{"type":2417,"value":389},"text",1787666705905]