[{"data":1,"prerenderedAt":2328},["ShallowReactive",2],{"navigation":3,"-docs-working-with-the-rest-api-fetch-tail-rest-api-ver3":523,"-docs-working-with-the-rest-api-fetch-tail-rest-api-ver3-description":2317},[4],{"title":5,"path":6,"stem":7,"children":8,"page":47},"Docs","\u002Fdocs","docs",[9,83,408,415],{"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,68],{"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,63],{"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,"path":65,"stem":66,"restApiVersion":15,"category":15,"description":67,"badge":15},"Inside 2.x","\u002Fdocs\u002Fgetting-started\u002Fmigration\u002Fwithin-2x","docs\u002F1.getting-started\u002F3.migration\u002F3.within-2x","Changes within the 2.x line that need a change on your side even though no API was removed — what breaks, how to tell, and what to do.",{"title":69,"restApiVersion":15,"category":15,"description":15,"badge":15,"path":70,"stem":71,"children":72,"page":47},"AI Tools","\u002Fdocs\u002Fgetting-started\u002Fai","docs\u002F1.getting-started\u002F7.ai",[73,78],{"title":74,"path":75,"stem":76,"restApiVersion":15,"category":15,"description":77,"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":79,"path":80,"stem":81,"restApiVersion":15,"category":15,"description":82,"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":84,"path":85,"stem":86,"children":87,"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",[88,91,98,103,108,112,117,122,126,131,136,141,145,150,155,160,165,170,175,180,185,190,194,199,204,209,214,220,225,230,235,240,245,250,255,260,265,271,276,281,287,292,297,302,307,313,319,324,329,335,340,345,350,355,360,366,373,378,383,388,393,398,403],{"title":89,"path":85,"stem":86,"restApiVersion":15,"category":15,"description":90,"badge":15},"Introduction","Overview of SDK capabilities for working with Bitrix24 REST API",{"title":92,"path":93,"stem":94,"restApiVersion":95,"category":96,"description":97,"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":92,"path":99,"stem":100,"restApiVersion":101,"category":96,"description":102,"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":104,"path":105,"stem":106,"restApiVersion":95,"category":96,"description":107,"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":104,"path":109,"stem":110,"restApiVersion":101,"category":96,"description":111,"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":113,"path":114,"stem":115,"restApiVersion":101,"category":96,"description":116,"badge":15},"CallTail","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-tail-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F2.call-tail-rest-api-ver3","Method for retrieving all records of a REST API version 3 tail method through the server's native keyset cursor.",{"title":118,"path":119,"stem":120,"restApiVersion":95,"category":96,"description":121,"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":118,"path":123,"stem":124,"restApiVersion":101,"category":96,"description":125,"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":127,"path":128,"stem":129,"restApiVersion":101,"category":96,"description":130,"badge":15},"FetchTail","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffetch-tail-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F2.fetch-tail-rest-api-ver3","Async generator that streams all records of a REST API version 3 tail method through the server's native keyset cursor.",{"title":132,"path":133,"stem":134,"restApiVersion":15,"category":132,"description":135,"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":137,"path":138,"stem":139,"restApiVersion":95,"category":96,"description":140,"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":137,"path":142,"stem":143,"restApiVersion":101,"category":96,"description":144,"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. The SDK sends up to 50 commands in a single API call.",{"title":89,"path":146,"stem":147,"restApiVersion":15,"category":148,"description":149,"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":151,"path":152,"stem":153,"restApiVersion":15,"category":148,"description":154,"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":156,"path":157,"stem":158,"restApiVersion":15,"category":148,"description":159,"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":161,"path":162,"stem":163,"restApiVersion":15,"category":148,"description":164,"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":166,"path":167,"stem":168,"restApiVersion":15,"category":148,"description":169,"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":171,"path":172,"stem":173,"restApiVersion":15,"category":148,"description":174,"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":176,"path":177,"stem":178,"restApiVersion":15,"category":148,"description":179,"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":181,"path":182,"stem":183,"restApiVersion":15,"category":148,"description":184,"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":186,"path":187,"stem":188,"restApiVersion":95,"category":96,"description":189,"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":186,"path":191,"stem":192,"restApiVersion":101,"category":96,"description":193,"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":195,"path":196,"stem":197,"restApiVersion":101,"category":96,"description":198,"badge":15},"DeferredBatch","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fdeferred-batch-rest-api-ver3","docs\u002F2.working-with-the-rest-api\u002F4.deferred-batch-rest-api-ver3","Deferred (background) batch for Bitrix24 REST API version 3: send thousands of commands in one call, follow the job status, and get the decoded rows — in one call with make(), or step by step.",{"title":200,"path":201,"stem":202,"restApiVersion":15,"category":200,"description":203,"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":205,"path":206,"stem":207,"restApiVersion":15,"category":15,"description":208,"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, BatchByChunk and DeferredBatch in REST API v2 and v3.",{"title":210,"path":211,"stem":212,"restApiVersion":15,"category":15,"description":213,"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":215,"path":216,"stem":217,"restApiVersion":15,"category":218,"description":219,"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":221,"path":222,"stem":223,"restApiVersion":15,"category":218,"description":224,"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":226,"path":227,"stem":228,"restApiVersion":15,"category":218,"description":229,"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":231,"path":232,"stem":233,"restApiVersion":15,"category":218,"description":234,"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":236,"path":237,"stem":238,"restApiVersion":15,"category":218,"description":239,"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":241,"path":242,"stem":243,"restApiVersion":15,"category":218,"description":244,"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":246,"path":247,"stem":248,"restApiVersion":15,"category":218,"description":249,"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":251,"path":252,"stem":253,"restApiVersion":15,"category":218,"description":254,"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":256,"path":257,"stem":258,"restApiVersion":15,"category":15,"description":259,"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":261,"path":262,"stem":263,"restApiVersion":15,"category":261,"description":264,"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":266,"path":267,"stem":268,"restApiVersion":15,"category":269,"description":270,"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":272,"path":273,"stem":274,"restApiVersion":15,"category":269,"description":275,"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":277,"path":278,"stem":279,"restApiVersion":15,"category":15,"description":280,"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":282,"path":283,"stem":284,"restApiVersion":15,"category":285,"description":286,"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":288,"path":289,"stem":290,"restApiVersion":15,"category":285,"description":291,"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":293,"path":294,"stem":295,"restApiVersion":15,"category":285,"description":296,"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":298,"path":299,"stem":300,"restApiVersion":15,"category":285,"description":301,"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":303,"path":304,"stem":305,"restApiVersion":15,"category":285,"description":306,"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":308,"path":309,"stem":310,"restApiVersion":15,"category":311,"description":312,"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":314,"path":315,"stem":316,"restApiVersion":15,"category":317,"description":318,"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":320,"path":321,"stem":322,"restApiVersion":15,"category":15,"description":323,"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":325,"path":326,"stem":327,"restApiVersion":15,"category":15,"description":328,"badge":15},"Discovering entity fields","\u002Fdocs\u002Fworking-with-the-rest-api\u002Fdiscovering-entity-fields","docs\u002F2.working-with-the-rest-api\u002F8.discovering-entity-fields","Ask the portal which fields an entity has, what type each one is, and whether it can be filtered, sorted or written — instead of guessing them or downloading the whole OpenAPI document. Also states the v3 camelCase field-name rule.",{"title":330,"path":331,"stem":332,"restApiVersion":15,"category":333,"description":334,"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":336,"path":337,"stem":338,"restApiVersion":15,"category":333,"description":339,"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()`, `isBrowserLikeRuntime()` and the `Environment` enum for branching between browser, worker and Node.js code paths.",{"title":341,"path":342,"stem":343,"restApiVersion":15,"category":333,"description":344,"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":346,"path":347,"stem":348,"restApiVersion":15,"category":333,"description":349,"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":351,"path":352,"stem":353,"restApiVersion":15,"category":333,"description":354,"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":356,"path":357,"stem":358,"restApiVersion":15,"category":333,"description":359,"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":361,"path":362,"stem":363,"restApiVersion":15,"category":364,"description":365,"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":367,"path":368,"stem":369,"children":370,"restApiVersion":15,"category":364,"description":372,"badge":15},"Types overview","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-index","docs\u002F2.working-with-the-rest-api\u002F90.types-index",[371],{"title":367,"path":368,"stem":369,"restApiVersion":15,"category":364,"description":372,"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":374,"path":375,"stem":376,"restApiVersion":15,"category":364,"description":377,"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":379,"path":380,"stem":381,"restApiVersion":15,"category":364,"description":382,"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":384,"path":385,"stem":386,"restApiVersion":15,"category":364,"description":387,"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":389,"path":390,"stem":391,"restApiVersion":15,"category":285,"description":392,"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":394,"path":395,"stem":396,"restApiVersion":15,"category":285,"description":397,"badge":15},"Error Codes","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ferror-codes","docs\u002F2.working-with-the-rest-api\u002F96.error-codes","Codes with a pinned classification — \"hard\" (thrown) and \"soft\" (returned as AjaxError inside AjaxResult) — and the category rule that covers everything else on restApi:v3.",{"title":399,"path":400,"stem":401,"restApiVersion":15,"category":333,"description":402,"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":404,"path":405,"stem":406,"restApiVersion":15,"category":333,"description":407,"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":409,"path":410,"stem":411,"children":412,"restApiVersion":15,"category":15,"description":15,"badge":15},"API Reference","\u002Fdocs\u002Fapi-reference","docs\u002F3.api-reference\u002F1.index",[413],{"title":409,"path":410,"stem":411,"restApiVersion":15,"category":15,"description":414,"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":416,"path":417,"stem":418,"children":419,"restApiVersion":15,"category":15,"description":15,"badge":15},"Examples","\u002Fdocs\u002Fexamples","docs\u002F99.examples\u002F0.index",[420,422,428,433,438,443,448,453,458,463,468,473,478,483,488,493,498,503,508,513,518],{"title":89,"path":417,"stem":418,"restApiVersion":15,"category":15,"description":421,"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":423,"path":424,"stem":425,"restApiVersion":15,"category":426,"description":427,"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":429,"path":430,"stem":431,"restApiVersion":15,"category":426,"description":432,"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":434,"path":435,"stem":436,"restApiVersion":15,"category":15,"description":437,"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":439,"path":440,"stem":441,"restApiVersion":15,"category":426,"description":442,"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":444,"path":445,"stem":446,"restApiVersion":15,"category":426,"description":447,"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":449,"path":450,"stem":451,"restApiVersion":15,"category":426,"description":452,"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":454,"path":455,"stem":456,"restApiVersion":15,"category":426,"description":457,"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":459,"path":460,"stem":461,"restApiVersion":15,"category":426,"description":462,"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":464,"path":465,"stem":466,"restApiVersion":15,"category":15,"description":467,"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":469,"path":470,"stem":471,"restApiVersion":15,"category":426,"description":472,"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":474,"path":475,"stem":476,"restApiVersion":15,"category":426,"description":477,"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":479,"path":480,"stem":481,"restApiVersion":15,"category":15,"description":482,"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":484,"path":485,"stem":486,"restApiVersion":15,"category":426,"description":487,"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":489,"path":490,"stem":491,"restApiVersion":15,"category":426,"description":492,"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":494,"path":495,"stem":496,"restApiVersion":15,"category":426,"description":497,"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":499,"path":500,"stem":501,"restApiVersion":15,"category":426,"description":502,"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":504,"path":505,"stem":506,"restApiVersion":15,"category":426,"description":507,"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":509,"path":510,"stem":511,"restApiVersion":15,"category":426,"description":512,"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":514,"path":515,"stem":516,"restApiVersion":15,"category":426,"description":517,"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":519,"path":520,"stem":521,"restApiVersion":15,"category":426,"description":522,"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":524,"title":525,"audited":526,"badge":15,"body":527,"category":96,"cookbookOrder":15,"description":130,"extension":2290,"featured":47,"links":2291,"meta":2313,"navigation":2314,"path":128,"restApiVersion":101,"scopes":15,"seo":2315,"stack":15,"stem":129,"__hash__":2316},"docs\u002Fdocs\u002F2.working-with-the-rest-api\u002F2.fetch-tail-rest-api-ver3.md","FetchTailV3.make","2026-09-16",{"type":528,"value":529,"toc":2271},"minimark",[530,535,569,581,602,851,856,882,892,896,954,997,1004,1030,1034,1062,1072,1076,1087,1243,1247,1250,1279,1293,1304,1484,1503,1507,1511,1514,1682,1690,1692,1696,2037,2041,2047,2212,2230,2234,2267],[531,532,534],"h2",{"id":533},"overview","Overview",[536,537,538,559,560,563,564,568],"p",{},[539,540,544,549,553,556],"code",{"className":541,"language":542,"style":543},"language-ts-type shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","ts-type","",[545,546,548],"span",{"class":547},"sBMFI","FetchTailV3",[545,550,552],{"class":551},"sMK4o",".",[545,554,555],{"class":547},"make",[545,557,558],{"class":551},"()"," walks a ",[539,561,562],{},"restApi:v3"," ",[565,566,567],"strong",{},"tail"," method through the server's native keyset cursor and yields each page as it arrives, so a dataset larger than memory can be processed a page at a time.",[536,570,571,572,580],{},"It is the streaming counterpart of ",[573,574,576],"a",{"href":575},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-tail-rest-api-ver3\u002F",[539,577,578],{"className":541,"language":542,"style":543},[545,579,113],{"class":547},"; everything about the cursor, the filter shapes and the errors is the same, and that page documents it in full. What follows is what differs.",[582,583,584],"caution",{},[536,585,586,589,590,594,595,552],{},[565,587,588],{},"Check that the method exists first."," A tail endpoint is separate from its list counterpart and few modules publish one — see ",[573,591,593],{"href":592},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-tail-rest-api-ver3\u002F#overview","how to ask the portal",". For an ordinary list method use ",[573,596,598],{"href":597},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffetch-list-rest-api-ver3\u002F",[539,599,600],{"className":541,"language":542,"style":543},[545,601,118],{"class":547},[603,604,608],"pre",{"className":605,"code":606,"language":607,"meta":543,"style":543},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","for await (const page of $b24.actions.v3.fetchTail.make\u003C{ id: number }>({\n  method: 'main.eventlog.tail',\n  params: { select: ['id', 'auditTypeId'] },\n  cursorField: 'id',\n  customKeyForResult: 'items',\n  limit: 100\n})) {\n  \u002F\u002F `page` is one server page, already parsed\n  console.log(`Processing ${page.length} items`)\n}\n","ts",[539,609,610,679,700,742,758,775,787,798,805,845],{"__ignoreMap":543},[545,611,614,618,621,625,629,632,635,638,640,642,644,647,649,652,654,657,660,664,667,670,673,676],{"class":612,"line":613},"line",1,[545,615,617],{"class":616},"s7zQu","for",[545,619,620],{"class":616}," await",[545,622,624],{"class":623},"sTEyZ"," (",[545,626,628],{"class":627},"spNyl","const",[545,630,631],{"class":623}," page ",[545,633,634],{"class":551},"of",[545,636,637],{"class":623}," $b24",[545,639,552],{"class":551},[545,641,96],{"class":623},[545,643,552],{"class":551},[545,645,646],{"class":623},"v3",[545,648,552],{"class":551},[545,650,651],{"class":623},"fetchTail",[545,653,552],{"class":551},[545,655,555],{"class":656},"s2Zo4",[545,658,659],{"class":551},"\u003C{",[545,661,663],{"class":662},"swJcz"," id",[545,665,666],{"class":551},":",[545,668,669],{"class":547}," number",[545,671,672],{"class":551}," }>",[545,674,675],{"class":623},"(",[545,677,678],{"class":551},"{\n",[545,680,682,685,687,690,694,697],{"class":612,"line":681},2,[545,683,684],{"class":662},"  method",[545,686,666],{"class":551},[545,688,689],{"class":551}," '",[545,691,693],{"class":692},"sfazB","main.eventlog.tail",[545,695,696],{"class":551},"'",[545,698,699],{"class":551},",\n",[545,701,703,706,708,711,714,716,719,721,724,726,729,731,734,736,739],{"class":612,"line":702},3,[545,704,705],{"class":662},"  params",[545,707,666],{"class":551},[545,709,710],{"class":551}," {",[545,712,713],{"class":662}," select",[545,715,666],{"class":551},[545,717,718],{"class":623}," [",[545,720,696],{"class":551},[545,722,723],{"class":692},"id",[545,725,696],{"class":551},[545,727,728],{"class":551},",",[545,730,689],{"class":551},[545,732,733],{"class":692},"auditTypeId",[545,735,696],{"class":551},[545,737,738],{"class":623},"] ",[545,740,741],{"class":551},"},\n",[545,743,745,748,750,752,754,756],{"class":612,"line":744},4,[545,746,747],{"class":662},"  cursorField",[545,749,666],{"class":551},[545,751,689],{"class":551},[545,753,723],{"class":692},[545,755,696],{"class":551},[545,757,699],{"class":551},[545,759,761,764,766,768,771,773],{"class":612,"line":760},5,[545,762,763],{"class":662},"  customKeyForResult",[545,765,666],{"class":551},[545,767,689],{"class":551},[545,769,770],{"class":692},"items",[545,772,696],{"class":551},[545,774,699],{"class":551},[545,776,778,781,783],{"class":612,"line":777},6,[545,779,780],{"class":662},"  limit",[545,782,666],{"class":551},[545,784,786],{"class":785},"sbssI"," 100\n",[545,788,790,793,796],{"class":612,"line":789},7,[545,791,792],{"class":551},"}",[545,794,795],{"class":623},")) ",[545,797,678],{"class":551},[545,799,801],{"class":612,"line":800},8,[545,802,804],{"class":803},"sHwdD","  \u002F\u002F `page` is one server page, already parsed\n",[545,806,808,811,813,816,818,821,824,827,830,832,835,837,840,842],{"class":612,"line":807},9,[545,809,810],{"class":623},"  console",[545,812,552],{"class":551},[545,814,815],{"class":656},"log",[545,817,675],{"class":662},[545,819,820],{"class":551},"`",[545,822,823],{"class":692},"Processing ",[545,825,826],{"class":551},"${",[545,828,829],{"class":623},"page",[545,831,552],{"class":551},[545,833,834],{"class":623},"length",[545,836,792],{"class":551},[545,838,839],{"class":692}," items",[545,841,820],{"class":551},[545,843,844],{"class":662},")\n",[545,846,848],{"class":612,"line":847},10,[545,849,850],{"class":551},"}\n",[852,853,855],"h3",{"id":854},"when-to-use-fetchtailv3make","When to Use FetchTailV3.make()",[857,858,859,866,876],"ol",{},[860,861,862,865],"li",{},[565,863,864],{},"Large exports and migrations"," — rows are handed over and can be released, instead of accumulating.",[860,867,868,871,872,875],{},[565,869,870],{},"Early exit"," — ",[539,873,874],{},"break"," out of the loop and no further request is made.",[860,877,878,881],{},[565,879,880],{},"Progress that means something"," — you see each page as it lands.",[536,883,884,885,891],{},"Use ",[573,886,887],{"href":575},[539,888,889],{"className":541,"language":542,"style":543},[545,890,113],{"class":547}," instead when the whole result fits in memory and one array is simpler to work with.",[531,893,895],{"id":894},"method-signature","Method Signature",[603,897,899],{"className":541,"code":898,"language":542,"meta":543,"style":543},"make\u003CT = unknown>(\n  options: ActionFetchTailV3\n): AsyncGenerator\u003CT[]>\n",[539,900,901,923,934],{"__ignoreMap":543},[545,902,903,905,908,911,914,917,920],{"class":612,"line":613},[545,904,555],{"class":547},[545,906,907],{"class":551},"\u003C",[545,909,910],{"class":547},"T",[545,912,913],{"class":623}," = ",[545,915,916],{"class":547},"unknown",[545,918,919],{"class":551},">",[545,921,922],{"class":623},"(\n",[545,924,925,929,931],{"class":612,"line":681},[545,926,928],{"class":927},"sHdIc","  options",[545,930,666],{"class":551},[545,932,933],{"class":547}," ActionFetchTailV3\n",[545,935,936,939,941,944,946,948,951],{"class":612,"line":702},[545,937,938],{"class":623},")",[545,940,666],{"class":551},[545,942,943],{"class":547}," AsyncGenerator",[545,945,907],{"class":551},[545,947,910],{"class":547},[545,949,950],{"class":623},"[]",[545,952,953],{"class":551},">\n",[536,955,956,957,964,965,968,969,968,972,968,975,968,978,968,981,968,984,968,987,968,990,993,994,552],{},"The options are those of ",[573,958,960],{"href":959},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-tail-rest-api-ver3\u002F#parameters",[539,961,962],{"className":541,"language":542,"style":543},[545,963,113],{"class":547},": ",[539,966,967],{},"method",", ",[539,970,971],{},"params",[539,973,974],{},"cursorField",[539,976,977],{},"order",[539,979,980],{},"initialValue",[539,982,983],{},"customKeyForResult",[539,985,986],{},"requestId",[539,988,989],{},"limit",[539,991,992],{},"maxPages"," and ",[539,995,996],{},"signal",[536,998,999,1000,1003],{},"There is no ",[539,1001,1002],{},"progress"," callback here, and none is needed — the loop body runs once per page, which is the same signal a callback would carry.",[536,1005,1006,1007,1013,1014,1016,1017,1024,1025,1029],{},"Two rules from that page apply here unchanged and are easy to miss coming from the list walkers: the ",[565,1008,1009,1010],{},"cursor field must not appear in ",[539,1011,1012],{},"filter"," (the server refuses it), and ",[539,1015,1012],{}," may be the array form ",[565,1018,1019,1020,1023],{},"or a bare ",[539,1021,1022],{},"FilterV3"," logic group"," — the list walkers accept only the array, because they have to extend it. See ",[573,1026,1028],{"href":1027},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-tail-rest-api-ver3\u002F#choosing-a-cursor-field","Choosing a cursor field"," for what the field itself has to be.",[852,1031,1033],{"id":1032},"return-value","Return Value",[536,1035,1036,1049,1050,1053,1054,1057,1058,1061],{},[539,1037,1038,1041,1043,1045,1047],{"className":541,"language":542,"style":543},[545,1039,1040],{"class":547},"AsyncGenerator",[545,1042,907],{"class":551},[545,1044,910],{"class":547},[545,1046,950],{"class":623},[545,1048,919],{"class":551}," — yields one array per server page. ",[565,1051,1052],{},"Nothing happens until you consume it",": the first request is made on the first iteration, so a generator that is created and never iterated sends no traffic at all. That is also where every guard fires — wrapping only the ",[539,1055,1056],{},"make(...)"," call in a ",[539,1059,1060],{},"try"," catches nothing.",[536,1063,1064,1065,1068,1069,1071],{},"An empty result yields ",[565,1066,1067],{},"no page at all",", so the loop body never runs. A wrong ",[539,1070,983],{}," looks identical, because a key the walker cannot find reads as \"no data\" — check the key before concluding the portal had nothing.",[531,1073,1075],{"id":1074},"error-handling","Error Handling",[536,1077,1078,1079,1082,1083,1086],{},"Everything here ",[565,1080,1081],{},"throws",", which is the difference from ",[539,1084,1085],{},"callTail"," worth writing code around.",[1088,1089,1090,1103],"table",{},[1091,1092,1093],"thead",{},[1094,1095,1096,1100],"tr",{},[1097,1098,1099],"th",{},"Code",[1097,1101,1102],{},"When",[1104,1105,1106,1123,1160,1176,1192,1208,1218,1230],"tbody",{},[1094,1107,1108,1114],{},[1109,1110,1111],"td",{},[539,1112,1113],{},"JSSDK_ACTION_V3_TAIL_FILTER_INVALID",[1109,1115,1116,1118,1119,1122],{},[539,1117,1012],{}," was the ",[539,1120,1121],{},"restApi:v2"," object dialect. Raised on the first iteration, before any request.",[1094,1124,1125,1130],{},[1109,1126,1127],{},[539,1128,1129],{},"JSSDK_CORE_B24_FETCH_TAIL_DESC_REQUIRES_INITIAL_VALUE",[1109,1131,1132,1145,1146,1148,1149,1152,1153,1155,1156,1159],{},[539,1133,1134,1136,1138,1140,1143],{"className":541,"language":542,"style":543},[545,1135,977],{"class":547},[545,1137,666],{"class":551},[545,1139,689],{"class":551},[545,1141,1142],{"class":692},"DESC",[545,1144,696],{"class":551}," without ",[539,1147,980],{},". Note the ",[539,1150,1151],{},"FETCH_TAIL"," segment: ",[539,1154,1085],{}," raises the ",[539,1157,1158],{},"CALL_TAIL"," spelling, so match the exact string.",[1094,1161,1162,1167],{},[1109,1163,1164],{},[539,1165,1166],{},"JSSDK_CORE_B24_FETCH_TAIL_METHOD_API_V3",[1109,1168,1169,1170,1172,1173,1175],{},"The portal returned a soft error mid-walk. This is the one you will see most often, and it is the real asymmetry: ",[539,1171,1085],{}," folds the same failure into its ",[539,1174,303],{}," instead.",[1094,1177,1178,1183],{},[1109,1179,1180],{},[539,1181,1182],{},"JSSDK_ACTION_CURSOR_STALLED",[1109,1184,1185,1186,1188,1189,1191],{},"The cursor came back equal to the one just sent. Usually a ",[539,1187,974],{}," that is not the field the server pages by, or a method with no ",[539,1190,567],{}," endpoint at all.",[1094,1193,1194,1199],{},[1109,1195,1196],{},[539,1197,1198],{},"JSSDK_ACTION_CURSOR_WENT_BACKWARDS",[1109,1200,1201,1202,1204,1205,1207],{},"The cursor moved into a value already passed. With ",[539,1203,1142],{},", check ",[539,1206,980],{}," is the newest value.",[1094,1209,1210,1215],{},[1109,1211,1212],{},[539,1213,1214],{},"JSSDK_ACTION_MAX_PAGES_EXCEEDED",[1109,1216,1217],{},"The page ceiling was reached.",[1094,1219,1220,1225],{},[1109,1221,1222],{},[539,1223,1224],{},"JSSDK_ACTION_INVALID_MAX_PAGES",[1109,1226,1227,1229],{},[539,1228,992],{}," was not a positive integer. Raised on the first iteration, before any request.",[1094,1231,1232,1237],{},[1109,1233,1234],{},[539,1235,1236],{},"JSSDK_ACTION_ABORTED",[1109,1238,1239,1240,1242],{},"The ",[539,1241,996],{}," fired.",[852,1244,1246],{"id":1245},"where-this-really-differs-from-calltail","Where this really differs from CallTail",[536,1248,1249],{},"Three of these reach you differently:",[1251,1252,1253,1268],"ul",{},[860,1254,1255,993,1257,1259,1260,1264,1265,1267],{},[539,1256,1214],{},[539,1258,1236],{}," are bounds ",[1261,1262,1263],"em",{},"you"," set, so ",[539,1266,1085],{}," hands back the rows it collected with the error attached. A generator cannot — it has already yielded every page it read;",[860,1269,1270,1271,1273,1274,1276,1277,552],{},"a soft portal error is reported by ",[539,1272,1085],{}," on the ",[539,1275,303],{}," and here as ",[539,1278,1166],{},[536,1280,1281,1282,1285,1286,1289,1290,1292],{},"The rest throw from ",[565,1283,1284],{},"both"," walkers: ",[539,1287,1288],{},"await callTail.make(...)"," without a ",[539,1291,1060],{}," rejects on a stalled cursor exactly as the loop below does.",[536,1294,1295,1297,1298,1300,1301,1303],{},[539,1296,1085],{}," resolves a ",[539,1299,303],{}," and attaches a bound-related error to it, so the rows it did read survive. A generator cannot do that — it has already handed over every page it read — so it ",[565,1302,1081],{}," instead:",[603,1305,1307],{"className":605,"code":1306,"language":607,"meta":543,"style":543},"try {\n  for await (const page of $b24.actions.v3.fetchTail.make({\n    method: 'main.eventlog.tail',\n    cursorField: 'id',\n    customKeyForResult: 'items'\n  })) {\n    console.log(`Processing ${page.length} items`)\n  }\n}\ncatch (error) {\n  \u002F\u002F The pages already yielded have been processed. If that is not safe for your\n  \u002F\u002F consumer, undo them here — see the note below.\n  throw error\n}\n",[539,1308,1309,1316,1355,1370,1385,1399,1408,1439,1444,1448,1458,1464,1470,1479],{"__ignoreMap":543},[545,1310,1311,1313],{"class":612,"line":613},[545,1312,1060],{"class":616},[545,1314,1315],{"class":551}," {\n",[545,1317,1318,1321,1323,1325,1327,1330,1333,1335,1337,1339,1341,1343,1345,1347,1349,1351,1353],{"class":612,"line":681},[545,1319,1320],{"class":616},"  for",[545,1322,620],{"class":616},[545,1324,624],{"class":662},[545,1326,628],{"class":627},[545,1328,1329],{"class":623}," page",[545,1331,1332],{"class":551}," of",[545,1334,637],{"class":623},[545,1336,552],{"class":551},[545,1338,96],{"class":623},[545,1340,552],{"class":551},[545,1342,646],{"class":623},[545,1344,552],{"class":551},[545,1346,651],{"class":623},[545,1348,552],{"class":551},[545,1350,555],{"class":656},[545,1352,675],{"class":662},[545,1354,678],{"class":551},[545,1356,1357,1360,1362,1364,1366,1368],{"class":612,"line":702},[545,1358,1359],{"class":662},"    method",[545,1361,666],{"class":551},[545,1363,689],{"class":551},[545,1365,693],{"class":692},[545,1367,696],{"class":551},[545,1369,699],{"class":551},[545,1371,1372,1375,1377,1379,1381,1383],{"class":612,"line":744},[545,1373,1374],{"class":662},"    cursorField",[545,1376,666],{"class":551},[545,1378,689],{"class":551},[545,1380,723],{"class":692},[545,1382,696],{"class":551},[545,1384,699],{"class":551},[545,1386,1387,1390,1392,1394,1396],{"class":612,"line":760},[545,1388,1389],{"class":662},"    customKeyForResult",[545,1391,666],{"class":551},[545,1393,689],{"class":551},[545,1395,770],{"class":692},[545,1397,1398],{"class":551},"'\n",[545,1400,1401,1404,1406],{"class":612,"line":777},[545,1402,1403],{"class":551},"  }",[545,1405,795],{"class":662},[545,1407,678],{"class":551},[545,1409,1410,1413,1415,1417,1419,1421,1423,1425,1427,1429,1431,1433,1435,1437],{"class":612,"line":789},[545,1411,1412],{"class":623},"    console",[545,1414,552],{"class":551},[545,1416,815],{"class":656},[545,1418,675],{"class":662},[545,1420,820],{"class":551},[545,1422,823],{"class":692},[545,1424,826],{"class":551},[545,1426,829],{"class":623},[545,1428,552],{"class":551},[545,1430,834],{"class":623},[545,1432,792],{"class":551},[545,1434,839],{"class":692},[545,1436,820],{"class":551},[545,1438,844],{"class":662},[545,1440,1441],{"class":612,"line":800},[545,1442,1443],{"class":551},"  }\n",[545,1445,1446],{"class":612,"line":807},[545,1447,850],{"class":551},[545,1449,1450,1453,1456],{"class":612,"line":847},[545,1451,1452],{"class":616},"catch",[545,1454,1455],{"class":623}," (error) ",[545,1457,678],{"class":551},[545,1459,1461],{"class":612,"line":1460},11,[545,1462,1463],{"class":803},"  \u002F\u002F The pages already yielded have been processed. If that is not safe for your\n",[545,1465,1467],{"class":612,"line":1466},12,[545,1468,1469],{"class":803},"  \u002F\u002F consumer, undo them here — see the note below.\n",[545,1471,1473,1476],{"class":612,"line":1472},13,[545,1474,1475],{"class":616},"  throw",[545,1477,1478],{"class":623}," error\n",[545,1480,1482],{"class":612,"line":1481},14,[545,1483,850],{"class":551},[582,1485,1486],{},[536,1487,1488,1491,1492,1494,1495,1497,1498,993,1500,1502],{},[565,1489,1490],{},"A page that was yielded was already delivered."," If the walk stops with ",[539,1493,1182],{}," or ",[539,1496,1198],{},", the pages your loop already processed may contain duplicates — the server was repeating itself. A consumer that persisted them has to undo that. This is the opposite of ",[539,1499,1214],{},[539,1501,1236],{},", where what was read is correct and merely incomplete.",[531,1504,1506],{"id":1505},"what-else-differs-from-calltail","What else differs from CallTail",[852,1508,1510],{"id":1509},"stopping-early","Stopping early",[536,1512,1513],{},"Leaving the loop stops the walk; no further page is requested.",[603,1515,1517],{"className":605,"code":1516,"language":607,"meta":543,"style":543},"let seen = 0\n\nfor await (const page of $b24.actions.v3.fetchTail.make\u003C{ id: number }>({\n  method: 'main.eventlog.tail',\n  cursorField: 'id',\n  customKeyForResult: 'items'\n})) {\n  seen += page.length\n  if (seen >= 500) {\n    break\n  }\n}\n",[539,1518,1519,1533,1539,1585,1599,1613,1625,1633,1648,1669,1674,1678],{"__ignoreMap":543},[545,1520,1521,1524,1527,1530],{"class":612,"line":613},[545,1522,1523],{"class":627},"let",[545,1525,1526],{"class":623}," seen ",[545,1528,1529],{"class":551},"=",[545,1531,1532],{"class":785}," 0\n",[545,1534,1535],{"class":612,"line":681},[545,1536,1538],{"emptyLinePlaceholder":1537},true,"\n",[545,1540,1541,1543,1545,1547,1549,1551,1553,1555,1557,1559,1561,1563,1565,1567,1569,1571,1573,1575,1577,1579,1581,1583],{"class":612,"line":702},[545,1542,617],{"class":616},[545,1544,620],{"class":616},[545,1546,624],{"class":623},[545,1548,628],{"class":627},[545,1550,631],{"class":623},[545,1552,634],{"class":551},[545,1554,637],{"class":623},[545,1556,552],{"class":551},[545,1558,96],{"class":623},[545,1560,552],{"class":551},[545,1562,646],{"class":623},[545,1564,552],{"class":551},[545,1566,651],{"class":623},[545,1568,552],{"class":551},[545,1570,555],{"class":656},[545,1572,659],{"class":551},[545,1574,663],{"class":662},[545,1576,666],{"class":551},[545,1578,669],{"class":547},[545,1580,672],{"class":551},[545,1582,675],{"class":623},[545,1584,678],{"class":551},[545,1586,1587,1589,1591,1593,1595,1597],{"class":612,"line":744},[545,1588,684],{"class":662},[545,1590,666],{"class":551},[545,1592,689],{"class":551},[545,1594,693],{"class":692},[545,1596,696],{"class":551},[545,1598,699],{"class":551},[545,1600,1601,1603,1605,1607,1609,1611],{"class":612,"line":760},[545,1602,747],{"class":662},[545,1604,666],{"class":551},[545,1606,689],{"class":551},[545,1608,723],{"class":692},[545,1610,696],{"class":551},[545,1612,699],{"class":551},[545,1614,1615,1617,1619,1621,1623],{"class":612,"line":777},[545,1616,763],{"class":662},[545,1618,666],{"class":551},[545,1620,689],{"class":551},[545,1622,770],{"class":692},[545,1624,1398],{"class":551},[545,1626,1627,1629,1631],{"class":612,"line":789},[545,1628,792],{"class":551},[545,1630,795],{"class":623},[545,1632,678],{"class":551},[545,1634,1635,1638,1641,1643,1645],{"class":612,"line":800},[545,1636,1637],{"class":623},"  seen",[545,1639,1640],{"class":551}," +=",[545,1642,1329],{"class":623},[545,1644,552],{"class":551},[545,1646,1647],{"class":623},"length\n",[545,1649,1650,1653,1655,1658,1661,1664,1667],{"class":612,"line":807},[545,1651,1652],{"class":616},"  if",[545,1654,624],{"class":662},[545,1656,1657],{"class":623},"seen",[545,1659,1660],{"class":551}," >=",[545,1662,1663],{"class":785}," 500",[545,1665,1666],{"class":662},") ",[545,1668,678],{"class":551},[545,1670,1671],{"class":612,"line":847},[545,1672,1673],{"class":616},"    break\n",[545,1675,1676],{"class":612,"line":1460},[545,1677,1443],{"class":551},[545,1679,1680],{"class":612,"line":1466},[545,1681,850],{"class":551},[536,1683,1684,1685,1687,1688,552],{},"For a bound the SDK enforces rather than one you check yourself, pass ",[539,1686,992],{}," or a ",[539,1689,996],{},[531,1691,416],{"id":426},[852,1693,1695],{"id":1694},"streaming-an-export-oldest-first","Streaming an export, oldest first",[603,1697,1699],{"className":605,"code":1698,"language":607,"meta":543,"style":543},"import { SdkError } from '@bitrix24\u002Fb24jssdk'\n\nlet pages = 0\nlet rows = 0\n\ntry {\n  for await (const page of $b24.actions.v3.fetchTail.make\u003C{ id: number }>({\n    method: 'main.eventlog.tail',\n    params: { select: ['id', 'auditTypeId'] },\n    cursorField: 'id',\n    customKeyForResult: 'items',\n    limit: 100\n  })) {\n    rows += page.length\n    console.log(`page ${++pages}, ${rows} rows`)\n  }\n}\ncatch (error) {\n  if (error instanceof SdkError) {\n    console.error(`walk stopped: ${error.code}`)\n  }\n  throw error\n}\n",[539,1700,1701,1724,1728,1739,1750,1754,1760,1806,1820,1853,1867,1881,1890,1898,1911,1953,1958,1963,1972,1991,2020,2025,2032],{"__ignoreMap":543},[545,1702,1703,1706,1708,1711,1714,1717,1719,1722],{"class":612,"line":613},[545,1704,1705],{"class":616},"import",[545,1707,710],{"class":551},[545,1709,1710],{"class":623}," SdkError",[545,1712,1713],{"class":551}," }",[545,1715,1716],{"class":616}," from",[545,1718,689],{"class":551},[545,1720,1721],{"class":692},"@bitrix24\u002Fb24jssdk",[545,1723,1398],{"class":551},[545,1725,1726],{"class":612,"line":681},[545,1727,1538],{"emptyLinePlaceholder":1537},[545,1729,1730,1732,1735,1737],{"class":612,"line":702},[545,1731,1523],{"class":627},[545,1733,1734],{"class":623}," pages ",[545,1736,1529],{"class":551},[545,1738,1532],{"class":785},[545,1740,1741,1743,1746,1748],{"class":612,"line":744},[545,1742,1523],{"class":627},[545,1744,1745],{"class":623}," rows ",[545,1747,1529],{"class":551},[545,1749,1532],{"class":785},[545,1751,1752],{"class":612,"line":760},[545,1753,1538],{"emptyLinePlaceholder":1537},[545,1755,1756,1758],{"class":612,"line":777},[545,1757,1060],{"class":616},[545,1759,1315],{"class":551},[545,1761,1762,1764,1766,1768,1770,1772,1774,1776,1778,1780,1782,1784,1786,1788,1790,1792,1794,1796,1798,1800,1802,1804],{"class":612,"line":789},[545,1763,1320],{"class":616},[545,1765,620],{"class":616},[545,1767,624],{"class":662},[545,1769,628],{"class":627},[545,1771,1329],{"class":623},[545,1773,1332],{"class":551},[545,1775,637],{"class":623},[545,1777,552],{"class":551},[545,1779,96],{"class":623},[545,1781,552],{"class":551},[545,1783,646],{"class":623},[545,1785,552],{"class":551},[545,1787,651],{"class":623},[545,1789,552],{"class":551},[545,1791,555],{"class":656},[545,1793,659],{"class":551},[545,1795,663],{"class":662},[545,1797,666],{"class":551},[545,1799,669],{"class":547},[545,1801,672],{"class":551},[545,1803,675],{"class":662},[545,1805,678],{"class":551},[545,1807,1808,1810,1812,1814,1816,1818],{"class":612,"line":800},[545,1809,1359],{"class":662},[545,1811,666],{"class":551},[545,1813,689],{"class":551},[545,1815,693],{"class":692},[545,1817,696],{"class":551},[545,1819,699],{"class":551},[545,1821,1822,1825,1827,1829,1831,1833,1835,1837,1839,1841,1843,1845,1847,1849,1851],{"class":612,"line":807},[545,1823,1824],{"class":662},"    params",[545,1826,666],{"class":551},[545,1828,710],{"class":551},[545,1830,713],{"class":662},[545,1832,666],{"class":551},[545,1834,718],{"class":662},[545,1836,696],{"class":551},[545,1838,723],{"class":692},[545,1840,696],{"class":551},[545,1842,728],{"class":551},[545,1844,689],{"class":551},[545,1846,733],{"class":692},[545,1848,696],{"class":551},[545,1850,738],{"class":662},[545,1852,741],{"class":551},[545,1854,1855,1857,1859,1861,1863,1865],{"class":612,"line":847},[545,1856,1374],{"class":662},[545,1858,666],{"class":551},[545,1860,689],{"class":551},[545,1862,723],{"class":692},[545,1864,696],{"class":551},[545,1866,699],{"class":551},[545,1868,1869,1871,1873,1875,1877,1879],{"class":612,"line":1460},[545,1870,1389],{"class":662},[545,1872,666],{"class":551},[545,1874,689],{"class":551},[545,1876,770],{"class":692},[545,1878,696],{"class":551},[545,1880,699],{"class":551},[545,1882,1883,1886,1888],{"class":612,"line":1466},[545,1884,1885],{"class":662},"    limit",[545,1887,666],{"class":551},[545,1889,786],{"class":785},[545,1891,1892,1894,1896],{"class":612,"line":1472},[545,1893,1403],{"class":551},[545,1895,795],{"class":662},[545,1897,678],{"class":551},[545,1899,1900,1903,1905,1907,1909],{"class":612,"line":1481},[545,1901,1902],{"class":623},"    rows",[545,1904,1640],{"class":551},[545,1906,1329],{"class":623},[545,1908,552],{"class":551},[545,1910,1647],{"class":623},[545,1912,1914,1916,1918,1920,1922,1924,1927,1929,1932,1935,1937,1939,1941,1944,1946,1949,1951],{"class":612,"line":1913},15,[545,1915,1412],{"class":623},[545,1917,552],{"class":551},[545,1919,815],{"class":656},[545,1921,675],{"class":662},[545,1923,820],{"class":551},[545,1925,1926],{"class":692},"page ",[545,1928,826],{"class":551},[545,1930,1931],{"class":551},"++",[545,1933,1934],{"class":623},"pages",[545,1936,792],{"class":551},[545,1938,968],{"class":692},[545,1940,826],{"class":551},[545,1942,1943],{"class":623},"rows",[545,1945,792],{"class":551},[545,1947,1948],{"class":692}," rows",[545,1950,820],{"class":551},[545,1952,844],{"class":662},[545,1954,1956],{"class":612,"line":1955},16,[545,1957,1443],{"class":551},[545,1959,1961],{"class":612,"line":1960},17,[545,1962,850],{"class":551},[545,1964,1966,1968,1970],{"class":612,"line":1965},18,[545,1967,1452],{"class":616},[545,1969,1455],{"class":623},[545,1971,678],{"class":551},[545,1973,1975,1977,1979,1982,1985,1987,1989],{"class":612,"line":1974},19,[545,1976,1652],{"class":616},[545,1978,624],{"class":662},[545,1980,1981],{"class":623},"error",[545,1983,1984],{"class":551}," instanceof",[545,1986,1710],{"class":547},[545,1988,1666],{"class":662},[545,1990,678],{"class":551},[545,1992,1994,1996,1998,2000,2002,2004,2007,2009,2011,2013,2015,2018],{"class":612,"line":1993},20,[545,1995,1412],{"class":623},[545,1997,552],{"class":551},[545,1999,1981],{"class":656},[545,2001,675],{"class":662},[545,2003,820],{"class":551},[545,2005,2006],{"class":692},"walk stopped: ",[545,2008,826],{"class":551},[545,2010,1981],{"class":623},[545,2012,552],{"class":551},[545,2014,539],{"class":623},[545,2016,2017],{"class":551},"}`",[545,2019,844],{"class":662},[545,2021,2023],{"class":612,"line":2022},21,[545,2024,1443],{"class":551},[545,2026,2028,2030],{"class":612,"line":2027},22,[545,2029,1475],{"class":616},[545,2031,1478],{"class":623},[545,2033,2035],{"class":612,"line":2034},23,[545,2036,850],{"class":551},[852,2038,2040],{"id":2039},"newest-first","Newest first",[536,2042,2043,2044,666],{},"A descending walk needs an explicit starting point, because the server pages by ",[539,2045,2046],{},"field \u003C value",[603,2048,2050],{"className":605,"code":2049,"language":607,"meta":543,"style":543},"for await (const page of $b24.actions.v3.fetchTail.make\u003C{ id: number }>({\n  method: 'main.eventlog.tail',\n  cursorField: 'id',\n  order: 'DESC',\n  initialValue: Number.MAX_SAFE_INTEGER,\n  customKeyForResult: 'items'\n})) {\n  console.log(`Processing ${page.length} items`)\n}\n",[539,2051,2052,2098,2112,2126,2141,2158,2170,2178,2208],{"__ignoreMap":543},[545,2053,2054,2056,2058,2060,2062,2064,2066,2068,2070,2072,2074,2076,2078,2080,2082,2084,2086,2088,2090,2092,2094,2096],{"class":612,"line":613},[545,2055,617],{"class":616},[545,2057,620],{"class":616},[545,2059,624],{"class":623},[545,2061,628],{"class":627},[545,2063,631],{"class":623},[545,2065,634],{"class":551},[545,2067,637],{"class":623},[545,2069,552],{"class":551},[545,2071,96],{"class":623},[545,2073,552],{"class":551},[545,2075,646],{"class":623},[545,2077,552],{"class":551},[545,2079,651],{"class":623},[545,2081,552],{"class":551},[545,2083,555],{"class":656},[545,2085,659],{"class":551},[545,2087,663],{"class":662},[545,2089,666],{"class":551},[545,2091,669],{"class":547},[545,2093,672],{"class":551},[545,2095,675],{"class":623},[545,2097,678],{"class":551},[545,2099,2100,2102,2104,2106,2108,2110],{"class":612,"line":681},[545,2101,684],{"class":662},[545,2103,666],{"class":551},[545,2105,689],{"class":551},[545,2107,693],{"class":692},[545,2109,696],{"class":551},[545,2111,699],{"class":551},[545,2113,2114,2116,2118,2120,2122,2124],{"class":612,"line":702},[545,2115,747],{"class":662},[545,2117,666],{"class":551},[545,2119,689],{"class":551},[545,2121,723],{"class":692},[545,2123,696],{"class":551},[545,2125,699],{"class":551},[545,2127,2128,2131,2133,2135,2137,2139],{"class":612,"line":744},[545,2129,2130],{"class":662},"  order",[545,2132,666],{"class":551},[545,2134,689],{"class":551},[545,2136,1142],{"class":692},[545,2138,696],{"class":551},[545,2140,699],{"class":551},[545,2142,2143,2146,2148,2151,2153,2156],{"class":612,"line":760},[545,2144,2145],{"class":662},"  initialValue",[545,2147,666],{"class":551},[545,2149,2150],{"class":623}," Number",[545,2152,552],{"class":551},[545,2154,2155],{"class":623},"MAX_SAFE_INTEGER",[545,2157,699],{"class":551},[545,2159,2160,2162,2164,2166,2168],{"class":612,"line":777},[545,2161,763],{"class":662},[545,2163,666],{"class":551},[545,2165,689],{"class":551},[545,2167,770],{"class":692},[545,2169,1398],{"class":551},[545,2171,2172,2174,2176],{"class":612,"line":789},[545,2173,792],{"class":551},[545,2175,795],{"class":623},[545,2177,678],{"class":551},[545,2179,2180,2182,2184,2186,2188,2190,2192,2194,2196,2198,2200,2202,2204,2206],{"class":612,"line":800},[545,2181,810],{"class":623},[545,2183,552],{"class":551},[545,2185,815],{"class":656},[545,2187,675],{"class":662},[545,2189,820],{"class":551},[545,2191,823],{"class":692},[545,2193,826],{"class":551},[545,2195,829],{"class":623},[545,2197,552],{"class":551},[545,2199,834],{"class":623},[545,2201,792],{"class":551},[545,2203,839],{"class":692},[545,2205,820],{"class":551},[545,2207,844],{"class":662},[545,2209,2210],{"class":612,"line":807},[545,2211,850],{"class":551},[536,2213,2214,2215,2217,2218,2220,2221,2224,2225,2229],{},"Without ",[539,2216,980],{}," the walk raises ",[539,2219,1129],{}," rather than walking away empty. ",[539,2222,2223],{},"Number.MAX_SAFE_INTEGER"," suits a numeric field; for a datetime or any other string, see ",[573,2226,2228],{"href":2227},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-tail-rest-api-ver3\u002F#order-desc-requires-initialvalue","what to pass instead",". It fires on the first iteration, not when the generator is created — nothing runs until you consume it.",[531,2231,2233],{"id":2232},"alternatives-and-recommendations","Alternatives and Recommendations",[1251,2235,2236,2252,2261],{},[860,2237,2238,2244,2245,993,2248,552],{},[573,2239,2240],{"href":575},[539,2241,2242],{"className":541,"language":542,"style":543},[545,2243,113],{"class":547}," — the same walk collected into one array, and where the shared rules live: ",[573,2246,2247],{"href":1027},"choosing a cursor field",[573,2249,2251],{"href":2250},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fcall-tail-rest-api-ver3\u002F#a-complete-script","a complete script",[860,2253,2254,2260],{},[573,2255,2256],{"href":597},[539,2257,2258],{"className":541,"language":542,"style":543},[545,2259,118],{"class":547}," — the streaming walker for ordinary list methods.",[860,2262,2263,2266],{},[573,2264,210],{"href":2265},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Ffiltering\u002F"," — which filter shapes each walker accepts.",[2268,2269,2270],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}",{"title":543,"searchDepth":681,"depth":681,"links":2272},[2273,2276,2279,2282,2285,2289],{"id":533,"depth":681,"text":534,"children":2274},[2275],{"id":854,"depth":702,"text":855},{"id":894,"depth":681,"text":895,"children":2277},[2278],{"id":1032,"depth":702,"text":1033},{"id":1074,"depth":681,"text":1075,"children":2280},[2281],{"id":1245,"depth":702,"text":1246},{"id":1505,"depth":681,"text":1506,"children":2283},[2284],{"id":1509,"depth":702,"text":1510},{"id":426,"depth":681,"text":416,"children":2286},[2287,2288],{"id":1694,"depth":702,"text":1695},{"id":2039,"depth":702,"text":2040},{"id":2232,"depth":681,"text":2233},"md",[2292,2295,2298,2301,2304,2307,2310],{"label":548,"iconName":2293,"to":2294},"GitHubIcon","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Factions\u002Fv3\u002Ffetch-tail.ts",{"label":2296,"iconName":2293,"to":2297},"Keyset driver","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Factions\u002Fv3\u002F_keyset-paginate.ts",{"label":2299,"iconName":2293,"to":2300},"Walk bounds","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Factions\u002F_walk-bounds.ts",{"label":2302,"iconName":2293,"to":2303},"Cursor-stall guard","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Factions\u002F_cursor-stalled.ts",{"label":2305,"iconName":2293,"to":2306},"Cursor-direction check","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Factions\u002F_cursor-progress.ts",{"label":2308,"iconName":2293,"to":2309},"Skill — b24jssdk-rest","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fskills\u002Fb24jssdk-rest\u002FSKILL.md",{"label":2311,"iconName":2293,"to":2312},"SdkError","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Fsdk-error.ts",{},{"title":127},{"title":525,"description":130},"xDzXQ8zC-lWboZJmFn6RPQWIm2uP1-kWlqT3ikog8cM",{"data":2318,"body":2319},{},{"type":2320,"children":2321},"root",[2322],{"type":2323,"tag":536,"props":2324,"children":2325},"element",{},[2326],{"type":2327,"value":130},"text",1790836212002]