[{"data":1,"prerenderedAt":2469},["ShallowReactive",2],{"navigation":3,"-docs-working-with-the-rest-api-discovering-entity-fields":508,"-docs-working-with-the-rest-api-discovering-entity-fields-description":2458},[4],{"title":5,"path":6,"stem":7,"children":8,"page":47},"Docs","\u002Fdocs","docs",[9,83,393,400],{"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,121,126,131,135,140,145,150,155,160,165,170,175,180,184,189,194,199,205,210,215,220,225,230,235,240,245,250,256,261,266,272,277,282,287,292,298,304,309,314,320,325,330,335,340,345,351,358,363,368,373,378,383,388],{"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":95,"category":96,"description":116,"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":113,"path":118,"stem":119,"restApiVersion":101,"category":96,"description":120,"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":122,"path":123,"stem":124,"restApiVersion":15,"category":122,"description":125,"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":127,"path":128,"stem":129,"restApiVersion":95,"category":96,"description":130,"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":127,"path":132,"stem":133,"restApiVersion":101,"category":96,"description":134,"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":136,"stem":137,"restApiVersion":15,"category":138,"description":139,"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":141,"path":142,"stem":143,"restApiVersion":15,"category":138,"description":144,"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":146,"path":147,"stem":148,"restApiVersion":15,"category":138,"description":149,"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":151,"path":152,"stem":153,"restApiVersion":15,"category":138,"description":154,"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":156,"path":157,"stem":158,"restApiVersion":15,"category":138,"description":159,"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":161,"path":162,"stem":163,"restApiVersion":15,"category":138,"description":164,"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":166,"path":167,"stem":168,"restApiVersion":15,"category":138,"description":169,"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":171,"path":172,"stem":173,"restApiVersion":15,"category":138,"description":174,"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":176,"path":177,"stem":178,"restApiVersion":95,"category":96,"description":179,"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":176,"path":181,"stem":182,"restApiVersion":101,"category":96,"description":183,"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":185,"path":186,"stem":187,"restApiVersion":15,"category":185,"description":188,"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":190,"path":191,"stem":192,"restApiVersion":15,"category":15,"description":193,"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":195,"path":196,"stem":197,"restApiVersion":15,"category":15,"description":198,"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":200,"path":201,"stem":202,"restApiVersion":15,"category":203,"description":204,"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":206,"path":207,"stem":208,"restApiVersion":15,"category":203,"description":209,"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":211,"path":212,"stem":213,"restApiVersion":15,"category":203,"description":214,"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":216,"path":217,"stem":218,"restApiVersion":15,"category":203,"description":219,"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":221,"path":222,"stem":223,"restApiVersion":15,"category":203,"description":224,"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":226,"path":227,"stem":228,"restApiVersion":15,"category":203,"description":229,"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":231,"path":232,"stem":233,"restApiVersion":15,"category":203,"description":234,"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":236,"path":237,"stem":238,"restApiVersion":15,"category":203,"description":239,"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":241,"path":242,"stem":243,"restApiVersion":15,"category":15,"description":244,"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":246,"path":247,"stem":248,"restApiVersion":15,"category":246,"description":249,"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":251,"path":252,"stem":253,"restApiVersion":15,"category":254,"description":255,"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":257,"path":258,"stem":259,"restApiVersion":15,"category":254,"description":260,"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":262,"path":263,"stem":264,"restApiVersion":15,"category":15,"description":265,"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":267,"path":268,"stem":269,"restApiVersion":15,"category":270,"description":271,"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":273,"path":274,"stem":275,"restApiVersion":15,"category":270,"description":276,"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":278,"path":279,"stem":280,"restApiVersion":15,"category":270,"description":281,"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":283,"path":284,"stem":285,"restApiVersion":15,"category":270,"description":286,"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":288,"path":289,"stem":290,"restApiVersion":15,"category":270,"description":291,"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":293,"path":294,"stem":295,"restApiVersion":15,"category":296,"description":297,"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":299,"path":300,"stem":301,"restApiVersion":15,"category":302,"description":303,"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":305,"path":306,"stem":307,"restApiVersion":15,"category":15,"description":308,"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":310,"path":311,"stem":312,"restApiVersion":15,"category":15,"description":313,"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":315,"path":316,"stem":317,"restApiVersion":15,"category":318,"description":319,"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":321,"path":322,"stem":323,"restApiVersion":15,"category":318,"description":324,"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":326,"path":327,"stem":328,"restApiVersion":15,"category":318,"description":329,"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":331,"path":332,"stem":333,"restApiVersion":15,"category":318,"description":334,"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":336,"path":337,"stem":338,"restApiVersion":15,"category":318,"description":339,"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":341,"path":342,"stem":343,"restApiVersion":15,"category":318,"description":344,"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":346,"path":347,"stem":348,"restApiVersion":15,"category":349,"description":350,"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":352,"path":353,"stem":354,"children":355,"restApiVersion":15,"category":349,"description":357,"badge":15},"Types overview","\u002Fdocs\u002Fworking-with-the-rest-api\u002Ftypes-index","docs\u002F2.working-with-the-rest-api\u002F90.types-index",[356],{"title":352,"path":353,"stem":354,"restApiVersion":15,"category":349,"description":357,"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":359,"path":360,"stem":361,"restApiVersion":15,"category":349,"description":362,"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":364,"path":365,"stem":366,"restApiVersion":15,"category":349,"description":367,"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":369,"path":370,"stem":371,"restApiVersion":15,"category":349,"description":372,"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":374,"path":375,"stem":376,"restApiVersion":15,"category":270,"description":377,"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":379,"path":380,"stem":381,"restApiVersion":15,"category":270,"description":382,"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":384,"path":385,"stem":386,"restApiVersion":15,"category":318,"description":387,"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":389,"path":390,"stem":391,"restApiVersion":15,"category":318,"description":392,"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":394,"path":395,"stem":396,"children":397,"restApiVersion":15,"category":15,"description":15,"badge":15},"API Reference","\u002Fdocs\u002Fapi-reference","docs\u002F3.api-reference\u002F1.index",[398],{"title":394,"path":395,"stem":396,"restApiVersion":15,"category":15,"description":399,"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":401,"path":402,"stem":403,"children":404,"restApiVersion":15,"category":15,"description":15,"badge":15},"Examples","\u002Fdocs\u002Fexamples","docs\u002F99.examples\u002F0.index",[405,407,413,418,423,428,433,438,443,448,453,458,463,468,473,478,483,488,493,498,503],{"title":89,"path":402,"stem":403,"restApiVersion":15,"category":15,"description":406,"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":408,"path":409,"stem":410,"restApiVersion":15,"category":411,"description":412,"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":414,"path":415,"stem":416,"restApiVersion":15,"category":411,"description":417,"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":419,"path":420,"stem":421,"restApiVersion":15,"category":15,"description":422,"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":424,"path":425,"stem":426,"restApiVersion":15,"category":411,"description":427,"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":429,"path":430,"stem":431,"restApiVersion":15,"category":411,"description":432,"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":434,"path":435,"stem":436,"restApiVersion":15,"category":411,"description":437,"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":439,"path":440,"stem":441,"restApiVersion":15,"category":411,"description":442,"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":444,"path":445,"stem":446,"restApiVersion":15,"category":411,"description":447,"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":449,"path":450,"stem":451,"restApiVersion":15,"category":15,"description":452,"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":454,"path":455,"stem":456,"restApiVersion":15,"category":411,"description":457,"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":459,"path":460,"stem":461,"restApiVersion":15,"category":411,"description":462,"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":464,"path":465,"stem":466,"restApiVersion":15,"category":15,"description":467,"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":469,"path":470,"stem":471,"restApiVersion":15,"category":411,"description":472,"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":474,"path":475,"stem":476,"restApiVersion":15,"category":411,"description":477,"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":479,"path":480,"stem":481,"restApiVersion":15,"category":411,"description":482,"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":484,"path":485,"stem":486,"restApiVersion":15,"category":411,"description":487,"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":489,"path":490,"stem":491,"restApiVersion":15,"category":411,"description":492,"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":494,"path":495,"stem":496,"restApiVersion":15,"category":411,"description":497,"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":499,"path":500,"stem":501,"restApiVersion":15,"category":411,"description":502,"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":504,"path":505,"stem":506,"restApiVersion":15,"category":411,"description":507,"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":509,"title":510,"audited":511,"badge":15,"body":512,"category":15,"cookbookOrder":15,"description":313,"extension":2445,"featured":47,"links":2446,"meta":2454,"navigation":2455,"path":311,"restApiVersion":15,"scopes":15,"seo":2456,"stack":15,"stem":312,"__hash__":2457},"docs\u002Fdocs\u002F2.working-with-the-rest-api\u002F8.discovering-entity-fields.md","Discovering entity fields (*.field.list)","2026-09-05",{"type":513,"value":514,"toc":2436},"minimark",[515,520,529,549,596,613,617,620,863,881,996,1011,1015,1192,1217,1287,1341,1350,1381,1385,1414,1540,1645,1662,1754,1761,1780,1786,2053,2057,2091,2104,2107,2162,2183,2324,2332,2341,2345,2377,2384,2388,2432],[516,517,519],"h2",{"id":518},"overview","Overview",[521,522,523,524,528],"p",{},"Most ",[525,526,527],"code",{},"restApi:v3"," entities publish a pair of metadata methods:",[530,531,532,539],"ul",{},[533,534,535,538],"li",{},[525,536,537],{},"\u003Centity>.field.list"," — every field the entity has, as a list of descriptors;",[533,540,541,544,545,548],{},[525,542,543],{},"\u003Centity>.field.get"," — one field, by ",[525,546,547],{},"name",".",[521,550,551,552,556,557,560,561,564,565,568,569,572,573,576,577,576,580,583,584,587,588,591,592,595],{},"This is a large part of the v3 surface: ",[553,554,555],"strong",{},"91 of the 245 methods"," a measured cloud portal\npublishes belong to this family — 37%. Every module has it: ",[525,558,559],{},"rest"," 22, ",[525,562,563],{},"main"," 18, ",[525,566,567],{},"note"," 10,\n",[525,570,571],{},"bizprocdesigner"," 9, ",[525,574,575],{},"humanresources"," 8, ",[525,578,579],{},"tasks",[525,581,582],{},"mail"," 6, ",[525,585,586],{},"vibecodeconnector"," 6,\n",[525,589,590],{},"call"," 2, ",[525,593,594],{},"timeman"," 2.",[567,597,598],{},[521,599,600,604,605,608,609,612],{},[601,602,262],"a",{"href":603},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fdiscovering-v3-methods\u002F"," answers\n",[553,606,607],{},"which methods exist"," on a portal, with one document you fetch once and cache.\nThis page answers ",[553,610,611],{},"which fields this one entity has"," — a small, cheap call you can make\nper entity, which also carries per-field flags the OpenAPI document does not.",[516,614,616],{"id":615},"calling-it-through-the-sdk","Calling it through the SDK",[521,618,619],{},"An ordinary v3 call — no special helper:",[621,622,627],"pre",{"className":623,"code":624,"language":625,"meta":626,"style":626},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const response = await $b24.actions.v3.call.make\u003C{\n  items: Array\u003C{ name: string, type: string, sortable: boolean, filterable: boolean }>\n}>({ method: 'tasks.task.field.list' })\n\nconst fields = response.getData()?.result?.items ?? []\nconst sortable = fields.filter(field => field.sortable).map(field => field.name)\n","ts","",[525,628,629,675,732,765,772,810],{"__ignoreMap":626},[630,631,634,638,642,646,650,653,655,657,659,662,664,666,668,672],"span",{"class":632,"line":633},"line",1,[630,635,637],{"class":636},"spNyl","const",[630,639,641],{"class":640},"sTEyZ"," response ",[630,643,645],{"class":644},"sMK4o","=",[630,647,649],{"class":648},"s7zQu"," await",[630,651,652],{"class":640}," $b24",[630,654,548],{"class":644},[630,656,96],{"class":640},[630,658,548],{"class":644},[630,660,661],{"class":640},"v3",[630,663,548],{"class":644},[630,665,590],{"class":640},[630,667,548],{"class":644},[630,669,671],{"class":670},"s2Zo4","make",[630,673,674],{"class":644},"\u003C{\n",[630,676,678,682,685,689,692,695,697,700,703,706,708,710,712,715,717,720,722,725,727,729],{"class":632,"line":677},2,[630,679,681],{"class":680},"swJcz","  items",[630,683,684],{"class":644},":",[630,686,688],{"class":687},"sBMFI"," Array",[630,690,691],{"class":644},"\u003C{",[630,693,694],{"class":680}," name",[630,696,684],{"class":644},[630,698,699],{"class":687}," string",[630,701,702],{"class":644},",",[630,704,705],{"class":680}," type",[630,707,684],{"class":644},[630,709,699],{"class":687},[630,711,702],{"class":644},[630,713,714],{"class":680}," sortable",[630,716,684],{"class":644},[630,718,719],{"class":687}," boolean",[630,721,702],{"class":644},[630,723,724],{"class":680}," filterable",[630,726,684],{"class":644},[630,728,719],{"class":687},[630,730,731],{"class":644}," }>\n",[630,733,735,738,741,744,747,749,752,756,759,762],{"class":632,"line":734},3,[630,736,737],{"class":644},"}>",[630,739,740],{"class":640},"(",[630,742,743],{"class":644},"{",[630,745,746],{"class":680}," method",[630,748,684],{"class":644},[630,750,751],{"class":644}," '",[630,753,755],{"class":754},"sfazB","tasks.task.field.list",[630,757,758],{"class":644},"'",[630,760,761],{"class":644}," }",[630,763,764],{"class":640},")\n",[630,766,768],{"class":632,"line":767},4,[630,769,771],{"emptyLinePlaceholder":770},true,"\n",[630,773,775,777,780,782,785,787,790,793,796,799,801,804,807],{"class":632,"line":774},5,[630,776,637],{"class":636},[630,778,779],{"class":640}," fields ",[630,781,645],{"class":644},[630,783,784],{"class":640}," response",[630,786,548],{"class":644},[630,788,789],{"class":670},"getData",[630,791,792],{"class":640},"()",[630,794,795],{"class":644},"?.",[630,797,798],{"class":640},"result",[630,800,795],{"class":644},[630,802,803],{"class":640},"items ",[630,805,806],{"class":644},"??",[630,808,809],{"class":640}," []\n",[630,811,813,815,818,820,823,825,828,830,834,837,840,842,845,847,850,852,854,856,858,860],{"class":632,"line":812},6,[630,814,637],{"class":636},[630,816,817],{"class":640}," sortable ",[630,819,645],{"class":644},[630,821,822],{"class":640}," fields",[630,824,548],{"class":644},[630,826,827],{"class":670},"filter",[630,829,740],{"class":640},[630,831,833],{"class":832},"sHdIc","field",[630,835,836],{"class":636}," =>",[630,838,839],{"class":640}," field",[630,841,548],{"class":644},[630,843,844],{"class":640},"sortable)",[630,846,548],{"class":644},[630,848,849],{"class":670},"map",[630,851,740],{"class":640},[630,853,833],{"class":832},[630,855,836],{"class":636},[630,857,839],{"class":640},[630,859,548],{"class":644},[630,861,862],{"class":640},"name)\n",[521,864,865,866,871,872,874,875,880],{},"The rows arrive under ",[553,867,868],{},[525,869,870],{},"result.items",". ",[525,873,543],{}," answers with a single\ndescriptor under ",[553,876,877],{},[525,878,879],{},"result.item"," instead:",[621,882,884],{"className":623,"code":883,"language":625,"meta":626,"style":626},"const response = await $b24.actions.v3.call.make\u003C{\n  item: { name: string, type: string, sortable: boolean }\n}>({ method: 'tasks.task.field.get', params: { name: 'title' } })\n",[525,885,886,916,951],{"__ignoreMap":626},[630,887,888,890,892,894,896,898,900,902,904,906,908,910,912,914],{"class":632,"line":633},[630,889,637],{"class":636},[630,891,641],{"class":640},[630,893,645],{"class":644},[630,895,649],{"class":648},[630,897,652],{"class":640},[630,899,548],{"class":644},[630,901,96],{"class":640},[630,903,548],{"class":644},[630,905,661],{"class":640},[630,907,548],{"class":644},[630,909,590],{"class":640},[630,911,548],{"class":644},[630,913,671],{"class":670},[630,915,674],{"class":644},[630,917,918,921,923,926,928,930,932,934,936,938,940,942,944,946,948],{"class":632,"line":677},[630,919,920],{"class":680},"  item",[630,922,684],{"class":644},[630,924,925],{"class":644}," {",[630,927,694],{"class":680},[630,929,684],{"class":644},[630,931,699],{"class":687},[630,933,702],{"class":644},[630,935,705],{"class":680},[630,937,684],{"class":644},[630,939,699],{"class":687},[630,941,702],{"class":644},[630,943,714],{"class":680},[630,945,684],{"class":644},[630,947,719],{"class":687},[630,949,950],{"class":644}," }\n",[630,952,953,955,957,959,961,963,965,968,970,972,975,977,979,981,983,985,988,990,992,994],{"class":632,"line":734},[630,954,737],{"class":644},[630,956,740],{"class":640},[630,958,743],{"class":644},[630,960,746],{"class":680},[630,962,684],{"class":644},[630,964,751],{"class":644},[630,966,967],{"class":754},"tasks.task.field.get",[630,969,758],{"class":644},[630,971,702],{"class":644},[630,973,974],{"class":680}," params",[630,976,684],{"class":644},[630,978,925],{"class":644},[630,980,694],{"class":680},[630,982,684],{"class":644},[630,984,751],{"class":644},[630,986,987],{"class":754},"title",[630,989,758],{"class":644},[630,991,761],{"class":644},[630,993,761],{"class":644},[630,995,764],{"class":640},[521,997,998,999,1002,1003,1006,1007,1010],{},"Both accept an optional ",[525,1000,1001],{},"select",", which narrows the ",[553,1004,1005],{},"descriptor"," keys — pass\n",[525,1008,1009],{},"select: ['name', 'sortable']"," and each row comes back with those two keys only.",[516,1012,1014],{"id":1013},"what-a-descriptor-holds","What a descriptor holds",[1016,1017,1018,1031],"table",{},[1019,1020,1021],"thead",{},[1022,1023,1024,1028],"tr",{},[1025,1026,1027],"th",{},"Key",[1025,1029,1030],{},"What it means",[1032,1033,1034,1053,1080,1103,1122,1134,1144,1169,1182],"tbody",{},[1022,1035,1036,1041],{},[1037,1038,1039],"td",{},[525,1040,547],{},[1037,1042,1043,1044,1046,1047,1049,1050,548],{},"The field name to use in ",[525,1045,1001],{},", ",[525,1048,827],{}," and ",[525,1051,1052],{},"order",[1022,1054,1055,1060],{},[1037,1056,1057],{},[525,1058,1059],{},"type",[1037,1061,1062,1046,1069,1046,1074,1079],{},[525,1063,1066],{"className":1064,"language":1065,"style":626},"language-ts-type shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","ts-type",[630,1067,1068],{"class":687},"string",[525,1070,1071],{"className":1064,"language":1065,"style":626},[630,1072,1073],{"class":687},"integer",[525,1075,1076],{"className":1064,"language":1065,"style":626},[630,1077,1078],{"class":687},"datetime",", …",[1022,1081,1082,1090],{},[1037,1083,1084,1086,1087],{},[525,1085,987],{}," \u002F ",[525,1088,1089],{},"description",[1037,1091,1092,1093,1097,1098,548],{},"Human-readable labels. ",[525,1094,1095],{"className":1064,"language":1065,"style":626},[630,1096,1089],{"class":687}," is often ",[525,1099,1100],{"className":1064,"language":1065,"style":626},[630,1101,1102],{"class":687},"null",[1022,1104,1105,1110],{},[1037,1106,1107],{},[525,1108,1109],{},"filterable",[1037,1111,1112,1113,1115,1116,1121],{},"Whether the field may appear in ",[525,1114,827],{}," — ",[553,1117,1118,1119],{},"and in an aggregate ",[525,1120,1001],{},"; see below.",[1022,1123,1124,1129],{},[1037,1125,1126],{},[525,1127,1128],{},"sortable",[1037,1130,1131,1132,548],{},"Whether it may appear in ",[525,1133,1052],{},[1022,1135,1136,1141],{},[1037,1137,1138],{},[525,1139,1140],{},"editable",[1037,1142,1143],{},"Whether it may be written.",[1022,1145,1146,1151],{},[1037,1147,1148],{},[525,1149,1150],{},"requiredGroups",[1037,1152,1153,1154,548],{},"The operations the field is mandatory for, e.g. ",[525,1155,1156,1159,1161,1164,1166],{"className":1064,"language":1065,"style":626},[630,1157,1158],{"class":640},"[",[630,1160,758],{"class":644},[630,1162,1163],{"class":754},"add",[630,1165,758],{"class":644},[630,1167,1168],{"class":640},"]",[1022,1170,1171,1179],{},[1037,1172,1173,1086,1176],{},[525,1174,1175],{},"multiple",[525,1177,1178],{},"elementType",[1037,1180,1181],{},"Whether the value is a list, and of what.",[1022,1183,1184,1189],{},[1037,1185,1186],{},[525,1187,1188],{},"validationRules",[1037,1190,1191],{},"Portal-side constraints, when the field declares any.",[521,1193,1194,1197,1198,1046,1200,1049,1202,1204,1205,1209,1210,1216],{},[553,1195,1196],{},"Three of these have no other source."," ",[525,1199,1109],{},[525,1201,1140],{},[525,1203,1150],{},"\nappear nowhere in the OpenAPI document's request schema, so ",[1206,1207,1208],"em",{},"\"can I filter on this?\""," and\n",[1206,1211,1212,1213,1215],{},"\"what must I pass to ",[525,1214,1163],{},"?\""," are answerable here and nowhere else.",[1218,1219,1220],"warning",{},[521,1221,1222,1229,1230,1233,1234,1046,1237,1046,1240,1243,1244,1046,1247,1250,1251,1046,1254,1256,1257,1049,1260,1263,1264,1266,1267,1269,1270,1272,1273,1276,1277,1046,1280,1049,1283,1286],{},[553,1223,1224,1049,1226,1228],{},[525,1225,1128],{},[525,1227,1109],{}," are independent — do not infer one from the other."," They\nhappen to name the same five fields on ",[525,1231,1232],{},"main.eventlog"," (",[525,1235,1236],{},"id",[525,1238,1239],{},"timestampX",[525,1241,1242],{},"auditTypeId",",\n",[525,1245,1246],{},"userId",[525,1248,1249],{},"guestId"," of thirteen), which makes the coincidence look like a rule. It is not:\non ",[525,1252,1253],{},"tasks.task",[525,1255,987],{}," is ",[525,1258,1259],{},"sortable: true",[525,1261,1262],{},"filterable: false",", and exactly one field\nof ninety-five — ",[525,1265,1236],{}," — is filterable at all, against nineteen that are sortable. A rich\n",[525,1268,1052],{}," alongside a bare ",[525,1271,827],{}," is a normal state for a v3 entity, not a portal fault.\nUnder ",[525,1274,1275],{},"restApi:v2"," the same entity filters on ",[525,1278,1279],{},"RESPONSIBLE_ID",[525,1281,1282],{},"STATUS",[525,1284,1285],{},"GROUP_ID","\nhappily; that is a difference between the two APIs, not something to work around.",[567,1288,1289],{},[521,1290,1291,1296,1297,1300,1301,1303,1304,1307,1308,1197,1313,1318,1319,1321,1322,1325,1326,1336,1337,548],{},[553,1292,1293,1295],{},[525,1294,1109],{}," also gates aggregation, which the flag's name does not suggest.","\nA field that is selectable and comes back from ",[525,1298,1299],{},"list"," quite normally is still\nrefused by an aggregate ",[525,1302,1001],{}," unless it is filterable — the portal checks the\nsame attribute for both. Measured: the refusal is a ",[553,1305,1306],{},"soft"," failure\n(",[525,1309,1310],{"className":1064,"language":1065,"style":626},[630,1311,1312],{"class":687},"isSuccess",[525,1314,1315],{"className":1064,"language":1065,"style":626},[630,1316,1317],{"class":687},"false",", not a throw — a 4xx in the\n",[525,1320,527],{}," envelope), carrying\n",[525,1323,1324],{},"BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION"," and naming the\nfield in ",[525,1327,1328,1331,1334],{"className":1064,"language":1065,"style":626},[630,1329,1330],{"class":687},"validation",[630,1332,1333],{"class":640},"[].",[630,1335,833],{"class":687},". Match on the code and the field:\nthe message is localised. Given the ratio above, this is a real constraint on\nwhat you can ask a v3 entity to count —\nsee ",[601,1338,1340],{"href":1339},"\u002Fdocs\u002Fworking-with-the-rest-api\u002Fchoosing-the-right-method\u002F","Choosing the right method",[521,1342,1343,1256,1345,1349],{},[525,1344,1150],{},[525,1346,1347],{"className":1064,"language":1065,"style":626},[630,1348,1102],{"class":687}," rather than an empty array when a field is\nrequired by nothing — guard before iterating it.",[567,1351,1352],{},[521,1353,1354,1357,1358,1360,1361,1363,1364,1367,1368,1370,1371,1380],{},[553,1355,1356],{},"The flag is the source of truth, and the set moves."," Which fields an entity marks\n",[525,1359,1109],{}," or ",[525,1362,1128],{}," is decided by the Bitrix24 module that owns the entity, and it\nchanges from one module version to the next. The reference documentation states the current\nanswer per method — ",[525,1365,1366],{},"tasks.task.list"," on ",[525,1369,527],{},", for instance,\n",[601,1372,1376,1377,1379],{"href":1373,"rel":1374},"https:\u002F\u002Fapidocs.bitrix24.com\u002Fapi-reference\u002Ftasks\u002Ftasks-task-list-rest-v3.html",[1375],"nofollow","documents ",[525,1378,1236],{}," as the only supported filter","\n— but the portal in front of you is the one that answers your request. Read the flag rather\nthan assume, especially in code that has to keep working across portal upgrades.",[516,1382,1384],{"id":1383},"why-it-is-worth-the-call","Why it is worth the call",[521,1386,1387,1388,1360,1391,1394,1395,1397,1398,1400,1401,1405,1406,1409,1410,1413],{},"A v3 field that is not marked ",[525,1389,1390],{},"Filterable",[525,1392,1393],{},"Sortable"," is refused — the portal does not\nquietly ignore the clause. Both refusals were measured, on two entities. Both arrive\n",[553,1396,1306],{},": a 4xx in the ",[525,1399,527],{}," envelope is not thrown, so check\n",[525,1402,1403],{"className":1064,"language":1065,"style":626},[630,1404,1312],{"class":687}," rather than writing a ",[525,1407,1408],{},"try","\u002F",[525,1411,1412],{},"catch"," around these.",[621,1415,1417],{"className":623,"code":1416,"language":625,"meta":626,"style":626},"\u002F\u002F `title` has `filterable: false` — this answers HTTP 400\nawait $b24.actions.v3.call.make({\n  method: 'tasks.task.list',\n  params: { filter: [['title', '=', 'x']], select: ['id'] }\n})\n",[525,1418,1419,1425,1453,1468,1533],{"__ignoreMap":626},[630,1420,1421],{"class":632,"line":633},[630,1422,1424],{"class":1423},"sHwdD","\u002F\u002F `title` has `filterable: false` — this answers HTTP 400\n",[630,1426,1427,1430,1432,1434,1436,1438,1440,1442,1444,1446,1448,1450],{"class":632,"line":677},[630,1428,1429],{"class":648},"await",[630,1431,652],{"class":640},[630,1433,548],{"class":644},[630,1435,96],{"class":640},[630,1437,548],{"class":644},[630,1439,661],{"class":640},[630,1441,548],{"class":644},[630,1443,590],{"class":640},[630,1445,548],{"class":644},[630,1447,671],{"class":670},[630,1449,740],{"class":640},[630,1451,1452],{"class":644},"{\n",[630,1454,1455,1458,1460,1462,1464,1466],{"class":632,"line":734},[630,1456,1457],{"class":680},"  method",[630,1459,684],{"class":644},[630,1461,751],{"class":644},[630,1463,1366],{"class":754},[630,1465,758],{"class":644},[630,1467,1243],{"class":644},[630,1469,1470,1473,1475,1477,1480,1482,1485,1487,1489,1491,1493,1495,1497,1499,1501,1503,1506,1508,1511,1513,1516,1518,1521,1523,1525,1527,1530],{"class":632,"line":767},[630,1471,1472],{"class":680},"  params",[630,1474,684],{"class":644},[630,1476,925],{"class":644},[630,1478,1479],{"class":680}," filter",[630,1481,684],{"class":644},[630,1483,1484],{"class":640}," [[",[630,1486,758],{"class":644},[630,1488,987],{"class":754},[630,1490,758],{"class":644},[630,1492,702],{"class":644},[630,1494,751],{"class":644},[630,1496,645],{"class":754},[630,1498,758],{"class":644},[630,1500,702],{"class":644},[630,1502,751],{"class":644},[630,1504,1505],{"class":754},"x",[630,1507,758],{"class":644},[630,1509,1510],{"class":640},"]]",[630,1512,702],{"class":644},[630,1514,1515],{"class":680}," select",[630,1517,684],{"class":644},[630,1519,1520],{"class":640}," [",[630,1522,758],{"class":644},[630,1524,1236],{"class":754},[630,1526,758],{"class":644},[630,1528,1529],{"class":640},"] ",[630,1531,1532],{"class":644},"}\n",[630,1534,1535,1538],{"class":632,"line":774},[630,1536,1537],{"class":644},"}",[630,1539,764],{"class":640},[621,1541,1545],{"className":1542,"code":1543,"language":1544,"meta":626,"style":626},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"error\": {\n    \"code\": \"BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION\",\n    \"validation\": [{ \"field\": \"title\", \"message\": \"…requires the `Filterable` attribute…\" }]\n  }\n}\n","json",[525,1546,1547,1551,1567,1587,1636,1641],{"__ignoreMap":626},[630,1548,1549],{"class":632,"line":633},[630,1550,1452],{"class":644},[630,1552,1553,1556,1559,1562,1564],{"class":632,"line":677},[630,1554,1555],{"class":644},"  \"",[630,1557,1558],{"class":636},"error",[630,1560,1561],{"class":644},"\"",[630,1563,684],{"class":644},[630,1565,1566],{"class":644}," {\n",[630,1568,1569,1572,1574,1576,1578,1581,1583,1585],{"class":632,"line":734},[630,1570,1571],{"class":644},"    \"",[630,1573,525],{"class":687},[630,1575,1561],{"class":644},[630,1577,684],{"class":644},[630,1579,1580],{"class":644}," \"",[630,1582,1324],{"class":754},[630,1584,1561],{"class":644},[630,1586,1243],{"class":644},[630,1588,1589,1591,1593,1595,1597,1600,1602,1605,1607,1609,1611,1613,1615,1617,1619,1622,1624,1626,1628,1631,1633],{"class":632,"line":767},[630,1590,1571],{"class":644},[630,1592,1330],{"class":687},[630,1594,1561],{"class":644},[630,1596,684],{"class":644},[630,1598,1599],{"class":644}," [{",[630,1601,1580],{"class":644},[630,1603,833],{"class":1604},"sbssI",[630,1606,1561],{"class":644},[630,1608,684],{"class":644},[630,1610,1580],{"class":644},[630,1612,987],{"class":754},[630,1614,1561],{"class":644},[630,1616,702],{"class":644},[630,1618,1580],{"class":644},[630,1620,1621],{"class":1604},"message",[630,1623,1561],{"class":644},[630,1625,684],{"class":644},[630,1627,1580],{"class":644},[630,1629,1630],{"class":754},"…requires the `Filterable` attribute…",[630,1632,1561],{"class":644},[630,1634,1635],{"class":644}," }]\n",[630,1637,1638],{"class":632,"line":774},[630,1639,1640],{"class":644},"  }\n",[630,1642,1643],{"class":632,"line":812},[630,1644,1532],{"class":644},[521,1646,1647,1648,1651,1652,1654,1655,1658,1659,1661],{},"Ordering by a field with ",[525,1649,1650],{},"sortable: false"," answers the same way, naming ",[525,1653,1393],{}," — measured\non ",[525,1656,1657],{},"main.eventlog.list"," ordered by ",[525,1660,1089],{},", one of the thirteen fields that method\nreturns:",[621,1663,1665],{"className":1542,"code":1664,"language":1544,"meta":626,"style":626},"{\n  \"error\": {\n    \"code\": \"BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION\",\n    \"validation\": [{ \"field\": \"description\", \"message\": \"…`EventLogDto`…`Sortable`…\" }]\n  }\n}\n",[525,1666,1667,1671,1683,1701,1746,1750],{"__ignoreMap":626},[630,1668,1669],{"class":632,"line":633},[630,1670,1452],{"class":644},[630,1672,1673,1675,1677,1679,1681],{"class":632,"line":677},[630,1674,1555],{"class":644},[630,1676,1558],{"class":636},[630,1678,1561],{"class":644},[630,1680,684],{"class":644},[630,1682,1566],{"class":644},[630,1684,1685,1687,1689,1691,1693,1695,1697,1699],{"class":632,"line":734},[630,1686,1571],{"class":644},[630,1688,525],{"class":687},[630,1690,1561],{"class":644},[630,1692,684],{"class":644},[630,1694,1580],{"class":644},[630,1696,1324],{"class":754},[630,1698,1561],{"class":644},[630,1700,1243],{"class":644},[630,1702,1703,1705,1707,1709,1711,1713,1715,1717,1719,1721,1723,1725,1727,1729,1731,1733,1735,1737,1739,1742,1744],{"class":632,"line":767},[630,1704,1571],{"class":644},[630,1706,1330],{"class":687},[630,1708,1561],{"class":644},[630,1710,684],{"class":644},[630,1712,1599],{"class":644},[630,1714,1580],{"class":644},[630,1716,833],{"class":1604},[630,1718,1561],{"class":644},[630,1720,684],{"class":644},[630,1722,1580],{"class":644},[630,1724,1089],{"class":754},[630,1726,1561],{"class":644},[630,1728,702],{"class":644},[630,1730,1580],{"class":644},[630,1732,1621],{"class":1604},[630,1734,1561],{"class":644},[630,1736,684],{"class":644},[630,1738,1580],{"class":644},[630,1740,1741],{"class":754},"…`EventLogDto`…`Sortable`…",[630,1743,1561],{"class":644},[630,1745,1635],{"class":644},[630,1747,1748],{"class":632,"line":774},[630,1749,1640],{"class":644},[630,1751,1752],{"class":632,"line":812},[630,1753,1532],{"class":644},[521,1755,1756,1757,1760],{},"A field being ",[553,1758,1759],{},"returned"," says nothing about whether it may be filtered or sorted on.",[1218,1762,1763],{},[521,1764,1765,1766,1256,1768,1771,1772,1775,1776,1779],{},"The ",[525,1767,1621],{},[553,1769,1770],{},"localised"," — a portal answers in the portal's language. Match on\n",[525,1773,1774],{},"error.code"," and on ",[525,1777,1778],{},"validation[].field",", never on the text.",[521,1781,1782,1783,548],{},"The useful habit is therefore: ",[553,1784,1785],{},"read the fields, then build the request",[621,1787,1789],{"className":623,"code":1788,"language":625,"meta":626,"style":626},"const meta = await $b24.actions.v3.call.make\u003C{\n  items: Array\u003C{ name: string, filterable: boolean, sortable: boolean }>\n}>({ method: 'tasks.task.field.list', params: { select: ['name', 'filterable', 'sortable'] } })\n\nconst fields = meta.getData()?.result?.items ?? []\nconst canFilterOn = new Set(fields.filter(field => field.filterable).map(field => field.name))\n\n\u002F\u002F On the portal measured, `tasks.task` exposes exactly one filterable field: `id`.\nif (canFilterOn.has('deadline')) {\n  \u002F\u002F …only then send a filter on `deadline`\n}\n",[525,1790,1791,1822,1856,1918,1922,1951,2003,2008,2014,2042,2048],{"__ignoreMap":626},[630,1792,1793,1795,1798,1800,1802,1804,1806,1808,1810,1812,1814,1816,1818,1820],{"class":632,"line":633},[630,1794,637],{"class":636},[630,1796,1797],{"class":640}," meta ",[630,1799,645],{"class":644},[630,1801,649],{"class":648},[630,1803,652],{"class":640},[630,1805,548],{"class":644},[630,1807,96],{"class":640},[630,1809,548],{"class":644},[630,1811,661],{"class":640},[630,1813,548],{"class":644},[630,1815,590],{"class":640},[630,1817,548],{"class":644},[630,1819,671],{"class":670},[630,1821,674],{"class":644},[630,1823,1824,1826,1828,1830,1832,1834,1836,1838,1840,1842,1844,1846,1848,1850,1852,1854],{"class":632,"line":677},[630,1825,681],{"class":680},[630,1827,684],{"class":644},[630,1829,688],{"class":687},[630,1831,691],{"class":644},[630,1833,694],{"class":680},[630,1835,684],{"class":644},[630,1837,699],{"class":687},[630,1839,702],{"class":644},[630,1841,724],{"class":680},[630,1843,684],{"class":644},[630,1845,719],{"class":687},[630,1847,702],{"class":644},[630,1849,714],{"class":680},[630,1851,684],{"class":644},[630,1853,719],{"class":687},[630,1855,731],{"class":644},[630,1857,1858,1860,1862,1864,1866,1868,1870,1872,1874,1876,1878,1880,1882,1884,1886,1888,1890,1892,1894,1896,1898,1900,1902,1904,1906,1908,1910,1912,1914,1916],{"class":632,"line":734},[630,1859,737],{"class":644},[630,1861,740],{"class":640},[630,1863,743],{"class":644},[630,1865,746],{"class":680},[630,1867,684],{"class":644},[630,1869,751],{"class":644},[630,1871,755],{"class":754},[630,1873,758],{"class":644},[630,1875,702],{"class":644},[630,1877,974],{"class":680},[630,1879,684],{"class":644},[630,1881,925],{"class":644},[630,1883,1515],{"class":680},[630,1885,684],{"class":644},[630,1887,1520],{"class":640},[630,1889,758],{"class":644},[630,1891,547],{"class":754},[630,1893,758],{"class":644},[630,1895,702],{"class":644},[630,1897,751],{"class":644},[630,1899,1109],{"class":754},[630,1901,758],{"class":644},[630,1903,702],{"class":644},[630,1905,751],{"class":644},[630,1907,1128],{"class":754},[630,1909,758],{"class":644},[630,1911,1529],{"class":640},[630,1913,1537],{"class":644},[630,1915,761],{"class":644},[630,1917,764],{"class":640},[630,1919,1920],{"class":632,"line":767},[630,1921,771],{"emptyLinePlaceholder":770},[630,1923,1924,1926,1928,1930,1933,1935,1937,1939,1941,1943,1945,1947,1949],{"class":632,"line":774},[630,1925,637],{"class":636},[630,1927,779],{"class":640},[630,1929,645],{"class":644},[630,1931,1932],{"class":640}," meta",[630,1934,548],{"class":644},[630,1936,789],{"class":670},[630,1938,792],{"class":640},[630,1940,795],{"class":644},[630,1942,798],{"class":640},[630,1944,795],{"class":644},[630,1946,803],{"class":640},[630,1948,806],{"class":644},[630,1950,809],{"class":640},[630,1952,1953,1955,1958,1960,1963,1966,1969,1971,1973,1975,1977,1979,1981,1983,1986,1988,1990,1992,1994,1996,1998,2000],{"class":632,"line":812},[630,1954,637],{"class":636},[630,1956,1957],{"class":640}," canFilterOn ",[630,1959,645],{"class":644},[630,1961,1962],{"class":644}," new",[630,1964,1965],{"class":670}," Set",[630,1967,1968],{"class":640},"(fields",[630,1970,548],{"class":644},[630,1972,827],{"class":670},[630,1974,740],{"class":640},[630,1976,833],{"class":832},[630,1978,836],{"class":636},[630,1980,839],{"class":640},[630,1982,548],{"class":644},[630,1984,1985],{"class":640},"filterable)",[630,1987,548],{"class":644},[630,1989,849],{"class":670},[630,1991,740],{"class":640},[630,1993,833],{"class":832},[630,1995,836],{"class":636},[630,1997,839],{"class":640},[630,1999,548],{"class":644},[630,2001,2002],{"class":640},"name))\n",[630,2004,2006],{"class":632,"line":2005},7,[630,2007,771],{"emptyLinePlaceholder":770},[630,2009,2011],{"class":632,"line":2010},8,[630,2012,2013],{"class":1423},"\u002F\u002F On the portal measured, `tasks.task` exposes exactly one filterable field: `id`.\n",[630,2015,2017,2020,2023,2025,2028,2030,2032,2035,2037,2040],{"class":632,"line":2016},9,[630,2018,2019],{"class":648},"if",[630,2021,2022],{"class":640}," (canFilterOn",[630,2024,548],{"class":644},[630,2026,2027],{"class":670},"has",[630,2029,740],{"class":640},[630,2031,758],{"class":644},[630,2033,2034],{"class":754},"deadline",[630,2036,758],{"class":644},[630,2038,2039],{"class":640},")) ",[630,2041,1452],{"class":644},[630,2043,2045],{"class":632,"line":2044},10,[630,2046,2047],{"class":1423},"  \u002F\u002F …only then send a filter on `deadline`\n",[630,2049,2051],{"class":632,"line":2050},11,[630,2052,1532],{"class":644},[516,2054,2056],{"id":2055},"field-names","Field names",[521,2058,2059,2064,2065,2067,2068,2070,2071,1046,2073,1046,2075,1046,2078,1046,2081,1046,2084,1243,2087,1046,2089,548],{},[553,2060,2061,2063],{},[525,2062,527],{}," field names are camelCase."," Measured across two entities and 108\ndescriptors — ",[525,2066,1253],{}," (95) and ",[525,2069,1232],{}," (13) — not one of the 108 starts with an\nuppercase letter: ",[525,2072,1236],{},[525,2074,987],{},[525,2076,2077],{},"creatorId",[525,2079,2080],{},"responsibleId",[525,2082,2083],{},"startPlan",[525,2085,2086],{},"storyPoints",[525,2088,1239],{},[525,2090,1242],{},[521,2092,2093,2095,2096,1046,2099,1046,2102,548],{},[525,2094,1275],{}," is the opposite: ",[525,2097,2098],{},"ID",[525,2100,2101],{},"TITLE",[525,2103,1279],{},[521,2105,2106],{},"That is the whole reason for the SDK's paging defaults, and it is a rule rather than a\nper-method quirk:",[1016,2108,2109,2121],{},[1019,2110,2111],{},[1022,2112,2113,2115],{},[1025,2114],{},[1025,2116,2117,2118],{},"Default ",[525,2119,2120],{},"idKey",[1032,2122,2123,2143],{},[1022,2124,2125,2133],{},[1037,2126,2127,1086,2130],{},[525,2128,2129],{},"actions.v3.callList",[525,2131,2132],{},"fetchList",[1037,2134,2135],{},[525,2136,2137,2139,2141],{"className":1064,"language":1065,"style":626},[630,2138,758],{"class":644},[630,2140,1236],{"class":754},[630,2142,758],{"class":644},[1022,2144,2145,2152],{},[1037,2146,2147,1086,2150],{},[525,2148,2149],{},"actions.v2.callList",[525,2151,2132],{},[1037,2153,2154],{},[525,2155,2156,2158,2160],{"className":1064,"language":1065,"style":626},[630,2157,758],{"class":644},[630,2159,2098],{"class":754},[630,2161,758],{"class":644},[521,2163,2164,2167,2168,2171,2172,1046,2174,2176,2177,2179,2180,2182],{},[525,2165,2166],{},"cursorIdKey"," exists for the methods that spell the id ",[553,2169,2170],{},"differently in the request and in\nthe response",". Under ",[525,2173,1275],{},[525,2175,1366],{}," is the known case: it returns a\nlowercase ",[525,2178,1236],{}," but filters on an uppercase ",[525,2181,2098],{},", so a walk left on the defaults reads the\ncursor from a field that is not there, never advances, and repeats the first page for ever.",[621,2184,2186],{"className":623,"code":2185,"language":625,"meta":626,"style":626},"\u002F\u002F restApi:v2 `tasks.task.list` — without `cursorIdKey` the walk never ends\nconst response = await $b24.actions.v2.callList.make({\n  method: 'tasks.task.list',\n  params: { select: ['ID', 'TITLE'] },\n  idKey: 'id',\n  cursorIdKey: 'ID',\n  customKeyForResult: 'tasks'\n})\n",[525,2187,2188,2193,2227,2241,2274,2289,2304,2318],{"__ignoreMap":626},[630,2189,2190],{"class":632,"line":633},[630,2191,2192],{"class":1423},"\u002F\u002F restApi:v2 `tasks.task.list` — without `cursorIdKey` the walk never ends\n",[630,2194,2195,2197,2199,2201,2203,2205,2207,2209,2211,2214,2216,2219,2221,2223,2225],{"class":632,"line":677},[630,2196,637],{"class":636},[630,2198,641],{"class":640},[630,2200,645],{"class":644},[630,2202,649],{"class":648},[630,2204,652],{"class":640},[630,2206,548],{"class":644},[630,2208,96],{"class":640},[630,2210,548],{"class":644},[630,2212,2213],{"class":640},"v2",[630,2215,548],{"class":644},[630,2217,2218],{"class":640},"callList",[630,2220,548],{"class":644},[630,2222,671],{"class":670},[630,2224,740],{"class":640},[630,2226,1452],{"class":644},[630,2228,2229,2231,2233,2235,2237,2239],{"class":632,"line":734},[630,2230,1457],{"class":680},[630,2232,684],{"class":644},[630,2234,751],{"class":644},[630,2236,1366],{"class":754},[630,2238,758],{"class":644},[630,2240,1243],{"class":644},[630,2242,2243,2245,2247,2249,2251,2253,2255,2257,2259,2261,2263,2265,2267,2269,2271],{"class":632,"line":767},[630,2244,1472],{"class":680},[630,2246,684],{"class":644},[630,2248,925],{"class":644},[630,2250,1515],{"class":680},[630,2252,684],{"class":644},[630,2254,1520],{"class":640},[630,2256,758],{"class":644},[630,2258,2098],{"class":754},[630,2260,758],{"class":644},[630,2262,702],{"class":644},[630,2264,751],{"class":644},[630,2266,2101],{"class":754},[630,2268,758],{"class":644},[630,2270,1529],{"class":640},[630,2272,2273],{"class":644},"},\n",[630,2275,2276,2279,2281,2283,2285,2287],{"class":632,"line":774},[630,2277,2278],{"class":680},"  idKey",[630,2280,684],{"class":644},[630,2282,751],{"class":644},[630,2284,1236],{"class":754},[630,2286,758],{"class":644},[630,2288,1243],{"class":644},[630,2290,2291,2294,2296,2298,2300,2302],{"class":632,"line":812},[630,2292,2293],{"class":680},"  cursorIdKey",[630,2295,684],{"class":644},[630,2297,751],{"class":644},[630,2299,2098],{"class":754},[630,2301,758],{"class":644},[630,2303,1243],{"class":644},[630,2305,2306,2309,2311,2313,2315],{"class":632,"line":2005},[630,2307,2308],{"class":680},"  customKeyForResult",[630,2310,684],{"class":644},[630,2312,751],{"class":644},[630,2314,579],{"class":754},[630,2316,2317],{"class":644},"'\n",[630,2319,2320,2322],{"class":632,"line":2010},[630,2321,1537],{"class":644},[630,2323,764],{"class":640},[521,2325,2326,2327,2329,2330,548],{},"Under ",[525,2328,527],{}," the same method needs no override — request and response agree on ",[525,2331,1236],{},[2333,2334,2335],"tip",{},[521,2336,2337,2338,2340],{},"When a walk returns rows but the same ones over and over, this is the first thing to check.\nAsk ",[525,2339,537],{}," what the response calls its id.",[516,2342,2344],{"id":2343},"availability","Availability",[521,2346,2347,2348,2351,2352,2355,2356,2359,2360,2363,2364,1046,2367,1049,2370,2373,2374,2376],{},"Near-universal, not universal. On the cloud portal measured, ",[553,2349,2350],{},"seven"," entities publish a\n",[525,2353,2354],{},".list"," with no matching ",[525,2357,2358],{},".field.list"," — the four ",[525,2361,2362],{},"crm.*.timeline.activity.email"," families,\n",[525,2365,2366],{},"humanresources.access.permission",[525,2368,2369],{},"humanresources.node.communication",[525,2371,2372],{},"rest.scope",".\nTreat a missing metadata method as ordinary: check ",[525,2375,1312],{}," and fall back to the OpenAPI\ndocument or to documented field names.",[521,2378,2379,2380,2383],{},"The counts here are ",[553,2381,2382],{},"portal-specific",", like the rest of the v3 surface — the portals\nmeasured published 147, 220 and 245 methods in total. Read them as an order of magnitude,\nnot a contract.",[516,2385,2387],{"id":2386},"alternatives-and-recommendations","Alternatives and Recommendations",[530,2389,2390,2404,2416],{},[533,2391,2392,1115,2395,2397,2398,1086,2400,1086,2402,548],{},[553,2393,2394],{},"One entity's fields, with flags",[525,2396,537],{},". Small, cheap, per entity,\nand the only source of ",[525,2399,1109],{},[525,2401,1140],{},[525,2403,1150],{},[533,2405,2406,2409,2410,2415],{},[553,2407,2408],{},"The whole method surface"," —\n",[601,2411,2412],{"href":603},[525,2413,2414],{},"rest.documentation.openapi",".\nOne document, often 100 KB or more; fetch it once and cache it.",[533,2417,2418,2421,2422,2424,2425,1086,2428,2431],{},[553,2419,2420],{},"Neither"," — for ",[525,2423,1275],{},", the classic ",[525,2426,2427],{},"crm.item.fields",[525,2429,2430],{},"*.fields"," methods still\napply; this family is v3.",[2433,2434,2435],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}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 .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 .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}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}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 .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 .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":626,"searchDepth":677,"depth":677,"links":2437},[2438,2439,2440,2441,2442,2443,2444],{"id":518,"depth":677,"text":519},{"id":615,"depth":677,"text":616},{"id":1013,"depth":677,"text":1014},{"id":1383,"depth":677,"text":1384},{"id":2055,"depth":677,"text":2056},{"id":2343,"depth":677,"text":2344},{"id":2386,"depth":677,"text":2387},"md",[2447,2451],{"label":2448,"iconName":2449,"to":2450},"Actions v3","GitHubIcon","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fpackages\u002Fjssdk\u002Fsrc\u002Fcore\u002Factions\u002Fv3\u002Fmanager-v3.ts",{"label":2452,"iconName":2449,"to":2453},"Skill — b24jssdk-rest","https:\u002F\u002Fgithub.com\u002Fbitrix24\u002Fb24jssdk\u002Fblob\u002Fmain\u002Fskills\u002Fb24jssdk-rest\u002FSKILL.md",{},{"title":310},{"title":510,"description":313},"egGfheO03CiBQyZ-v0EvZISPevkM0WD-UNnh6oW3lfw",{"data":2459,"body":2460},{},{"type":2461,"children":2462},"root",[2463],{"type":2464,"tag":521,"props":2465,"children":2466},"element",{},[2467],{"type":2468,"value":313},"text",1789370245356]