Bitrix24 Universal Lists API
The Universal Lists API from Bitrix24 — 19 operation(s) for universal lists.
OpenAPI Specification
openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector Universal Lists API
version: 1.0.0
description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
contact:
name: Bitrix24 Developer Support
url: https://apidocs.bitrix24.com/support.html
license:
name: MIT
url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
x-logo:
url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
description: Your Bitrix24 portal (cloud)
variables:
portal:
default: your-portal
description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
description: On-Premise Bitrix24 installation
variables:
host:
default: your-bitrix24.example.com
description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Universal Lists
paths:
/lists.add:
post:
summary: Create a universal list lists.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `lists.add` method creates a universal list.
operationId: lists_add
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/lists/lists-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block ||'
SOCNET_GROUP_ID:
type: integer
description: '| Group identifier. Use this parameter if you want to add the list to a group.'
FIELDS:
type: array
items: {}
description: '| Array of list fields.'
MESSAGES:
type: array
items: {}
description: '| Array of labels for list items and sections. Supported values:'
RIGHTS:
type: array
items: {}
description: '| Access permission settings for the list. An array in key-value format, where the key is the letter code of the user or department with the identifier, and the value is the letter code of the permission.'
NAME:
type: string
description: '| Name of the list ||'
DESCRIPTION:
type: string
description: '| Description of the list ||'
SORT:
type: integer
description: '| Sorting ||'
PICTURE:
type: array
items: {}
description: '| Picture. An object in the format `{fileData: [value1, value2]}`, where `value1` is the name of the picture file with the extension, and `value2` is the picture in base64 format ||'
BIZPROC:
type: string
description: '| Enabling business process support. Possible values:'
required:
- IBLOCK_TYPE_ID
- IBLOCK_CODE
- FIELDS
- NAME
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block ||'
SOCNET_GROUP_ID:
type: integer
description: '| Group identifier. Use this parameter if you want to add the list to a group.'
FIELDS:
type: array
items: {}
description: '| Array of list fields.'
MESSAGES:
type: array
items: {}
description: '| Array of labels for list items and sections. Supported values:'
RIGHTS:
type: array
items: {}
description: '| Access permission settings for the list. An array in key-value format, where the key is the letter code of the user or department with the identifier, and the value is the letter code of the permission.'
NAME:
type: string
description: '| Name of the list ||'
DESCRIPTION:
type: string
description: '| Description of the list ||'
SORT:
type: integer
description: '| Sorting ||'
PICTURE:
type: array
items: {}
description: '| Picture. An object in the format `{fileData: [value1, value2]}`, where `value1` is the name of the picture file with the extension, and `value2` is the picture in base64 format ||'
BIZPROC:
type: string
description: '| Enabling business process support. Possible values:'
required:
- IBLOCK_TYPE_ID
- IBLOCK_CODE
- FIELDS
- NAME
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- lists
/lists.delete:
post:
summary: Delete universal list lists.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.delete` removes a universal list.
operationId: lists_delete
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/lists/lists-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- lists
/lists.element.add:
post:
summary: Create a list element lists.element.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.add` creates a list element.
operationId: lists_element_add
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element ||'
FIELDS:
type: array
items: {}
description: '| Array of fields.'
IBLOCK_SECTION_ID:
type: integer
description: '| Identifier of the section to which the element is added.'
LIST_ELEMENT_URL:
type: string
description: '| Template address to the list elements.'
NAME:
type: string
description: '| Name of the element ||'
PROPERTY_PropertyId:
type: string
description: '| Custom properties.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_CODE
- FIELDS
- NAME
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element ||'
FIELDS:
type: array
items: {}
description: '| Array of fields.'
IBLOCK_SECTION_ID:
type: integer
description: '| Identifier of the section to which the element is added.'
LIST_ELEMENT_URL:
type: string
description: '| Template address to the list elements.'
NAME:
type: string
description: '| Name of the element ||'
PROPERTY_PropertyId:
type: string
description: '| Custom properties.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_CODE
- FIELDS
- NAME
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- lists
/lists.element.delete:
post:
summary: Delete List Element lists.element.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.delete` removes a list element.
operationId: lists_element_delete
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_ID
- ELEMENT_CODE
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_ID
- ELEMENT_CODE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- lists
/lists.element.get:
post:
summary: Get Element Parameters or List of Elements lists.element.get
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.get` returns an element or a list of elements.
operationId: lists_element_get
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-get.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
SELECT:
type: array
items: {}
description: '| An array containing a list of fields to select. If no fields are specified, all available fields are returned by default.'
FILTER:
type: object
description: '| An object for filtering element fields in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. The filterable field can take the following values:'
ELEMENT_ORDER:
type: object
description: '| An object for sorting element fields in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.'
start:
type: integer
description: '| This parameter is used to manage pagination.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
SELECT:
type: array
items: {}
description: '| An array containing a list of fields to select. If no fields are specified, all available fields are returned by default.'
FILTER:
type: object
description: '| An object for filtering element fields in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. The filterable field can take the following values:'
ELEMENT_ORDER:
type: object
description: '| An object for sorting element fields in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.'
start:
type: integer
description: '| This parameter is used to manage pagination.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- lists
/lists.element.get.file.url:
post:
summary: Get File Path lists.element.get.file.url
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.get.file.url` returns the file path.
operationId: lists_element_get_file_url
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-get-file-url.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
FIELD_ID:
type: integer
description: '| Identifier of the File or File (Drive) property, without the `PROPERTY_` prefix ||'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_ID
- ELEMENT_CODE
- FIELD_ID
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
FIELD_ID:
type: integer
description: '| Identifier of the File or File (Drive) property, without the `PROPERTY_` prefix ||'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_ID
- ELEMENT_CODE
- FIELD_ID
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- lists
/lists.element.update:
post:
summary: Update List Element lists.element.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.element.update` updates a list element. The method completely overwrites the element. Fields whose values are not provided will be cleared.
operationId: lists_element_update
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/elements/lists-element-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
FIELDS:
type: array
items: {}
description: '| Array of fields.'
NAME:
type: string
description: '| Name of the element ||'
PROPERTY_PropertyId:
type: string
description: '| Custom properties.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_ID
- ELEMENT_CODE
- FIELDS
- NAME
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
ELEMENT_ID:
type: integer
description: '| Identifier of the element.'
ELEMENT_CODE:
type: string
description: '| Symbolic code of the element.'
FIELDS:
type: array
items: {}
description: '| Array of fields.'
NAME:
type: string
description: '| Name of the element ||'
PROPERTY_PropertyId:
type: string
description: '| Custom properties.'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- ELEMENT_ID
- ELEMENT_CODE
- FIELDS
- NAME
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- lists
/lists.field.add:
post:
summary: Create a Field for Universal List lists.field.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `lists.field.add` creates a list field. You can find the available field types for the universal list using the method [lists.field.type.get](./lists-field-type-get.md)
operationId: lists_field_add
tags:
- Universal Lists
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/lists/fields/lists-field-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
FIELDS:
type: array
items: {}
description: '| Array of parameters.'
NAME:
type: string
description: '| Field name ||'
TYPE:
type: string
description: '| Field type. Once created, the field type cannot be changed.'
IS_REQUIRED:
type: string
description: '| Field required flag. Possible values:'
MULTIPLE:
type: string
description: '| Field multiplicity flag. Possible values:'
SORT:
type: integer
description: '| Sorting ||'
DEFAULT_VALUE:
type: string
description: '| Default value. If the `ADD_READ_ONLY_FIELD` setting is enabled in `SETTINGS`, this parameter becomes required ||'
LIST:
type: array
items: {}
description: '| Values for the List type field. An array in the format `{''ID'': { ''VALUE'': ''Value_1'', ''SORT'': 10, ''DEF'': ''N'' }}`, where `''ID''` — temporary identifier, `VALUE` — displayed text, `SORT` — sorting order, `DEF` — default value indicator.'
LIST_TEXT_VALUES:
type: string
description: '| An alternative way to specify values for the List type field. A string where values are separated by the newline character `\n`'
LIST_DEF:
type: array
items: {}
description: '| Default value for the List type field. The array accepts a temporary identifier from `LIST` ||'
CODE:
type: string
description: '| Symbolic code of the field. Required for custom fields. Not used for system fields ||'
SETTINGS:
type: array
items: {}
description: '| Display and behavior settings.'
USER_TYPE_SETTINGS:
type: array
items: {}
description: '| Array of settings for custom fields. The structure depends on the field type:'
ROW_COUNT:
type: integer
description: '| Height of the field.'
COL_COUNT:
type: integer
description: '| Width of the field.'
LINK_IBLOCK_ID:
type: integer
description: '| Identifier of the related list. Required for types Binding to sections, Binding to elements, and Binding to elements as a list ||'
required:
- IBLOCK_TYPE_ID
- IBLOCK_ID
- IBLOCK_CODE
- FIELDS
- NAME
- TYPE
application/x-www-form-urlencoded:
schema:
type: object
properties:
IBLOCK_TYPE_ID:
type: string
description: '| Identifier of the information block type. Possible values:'
IBLOCK_ID:
type: integer
description: '| Identifier of the information block.'
IBLOCK_CODE:
type: string
description: '| Symbolic code of the information block.'
FIELDS:
type: array
items: {}
description: '| Array of parameters.'
NAME:
type: string
description: '| Field nam
# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-universal-lists-api-openapi.yml