Bitrix24 Workgroups API

openapi: 3.0.3
info:
  title: Bitrix24 REST BIconnector Workgroups 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: Workgroups
paths:
  /feature.access:
    post:
      summary: Check the access permissions of the current user sonet_group.feature.access
      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 `sonet_group.feature.access` checks whether the current user has access to operations within the group or project functionality.
      operationId: feature_access
      tags:
      - Workgroups
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/sonet-group/sonet-group-feature-access.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                GROUP_ID:
                  type: integer
                  description: '| Identifier of the group or project.'
                FEATURE:
                  type: string
                  description: '| Symbolic code of the group functionality.'
                OPERATION:
                  type: string
                  description: '| Symbolic code of the operation within the functionality.'
              required:
              - GROUP_ID
              - FEATURE
              - OPERATION
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                GROUP_ID:
                  type: integer
                  description: '| Identifier of the group or project.'
                FEATURE:
                  type: string
                  description: '| Symbolic code of the group functionality.'
                OPERATION:
                  type: string
                  description: '| Symbolic code of the operation within the functionality.'
              required:
              - GROUP_ID
              - FEATURE
              - OPERATION
      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:
        - sonet
  /socialnetwork.api.workgroup.get:
    post:
      summary: Retrieve Data on Workgroup socialnetwork.api.workgroup.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 `socialnetwork.api.workgroup.get` returns information about a workgroup, project, scrum, or collaboration based on the identifier. An administrator can retrieve information about any group on the account, even if it is secret and they are not a member.
      operationId: socialnetwork_api_workgroup_get
      tags:
      - Workgroups
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/sonet-group/socialnetwork-api-workgroup-get.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                params:
                  type: object
                  description: '| Request parameters for retrieving the group. More details below ||'
                groupId:
                  type: integer
                  description: '| Group identifier. The value for this field can be obtained using the method sonet_group.get ||'
                select:
                  type: array
                  items: {}
                  description: '| List of additional fields to retrieve, returned in `result`. More details below ||'
                mode:
                  type: string
                  description: '| Request mode. Can only take the value `mobile`, which allows retrieving additional data in the array `result[ADDITIONAL_DATA]` ||'
                ACTIONS:
                  type: string
                  description: '| Operations available to the current user on the group ||'
                AVATAR:
                  type: string
                  description: '| URL of the group''s compressed user avatar ||'
                AVATAR_DATA:
                  type: string
                  description: '| Information about the group''s avatar ||'
                AVATAR_TYPES:
                  type: string
                  description: '| Types of avatars for groups ||'
                COUNTERS:
                  type: string
                  description: '| Number of unaccepted requests and invitations to join the group ||'
                DATE_CREATE:
                  type: string
                  description: '| Date and time of group creation in a more readable format ||'
                DEPARTMENTS:
                  type: string
                  description: '| Departments of employees added to the group ||'
                EFFICIENCY:
                  type: string
                  description: '| Group efficiency ||'
                FEATURES:
                  type: string
                  description: '| Available tools in the group specified in the advanced group settings ||'
                GROUP_MEMBERS_LIST:
                  type: string
                  description: '| List of active group members, invited users, and users awaiting confirmation to join the group ||'
                LIST_OF_MEMBERS:
                  type: string
                  description: '| List of group members with their information ||'
                LIST_OF_MEMBERS_AWAITING_INVITE:
                  type: string
                  description: '| Users awaiting confirmation to join the group ||'
                OWNER_DATA:
                  type: string
                  description: '| Data about the group owner ||'
                PIN:
                  type: string
                  description: '| Whether the group is pinned for the current user on the groups and projects page. Returned as `result[IS_PIN]` ||'
                PRIVACY_TYPE:
                  type: string
                  description: '| Group privacy level. Returned as `result[PRIVACY_CODE]` ||'
                SUBJECT_DATA:
                  type: string
                  description: '| Information about the group''s subject specified in the advanced group settings ||'
                TAGS:
                  type: string
                  description: '| Group tags specified in the advanced group settings ||'
                USER_DATA:
                  type: string
                  description: '| Data about the current user''s role in the group ||'
              required:
              - params
              - groupId
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                params:
                  type: object
                  description: '| Request parameters for retrieving the group. More details below ||'
                groupId:
                  type: integer
                  description: '| Group identifier. The value for this field can be obtained using the method sonet_group.get ||'
                select:
                  type: array
                  items: {}
                  description: '| List of additional fields to retrieve, returned in `result`. More details below ||'
                mode:
                  type: string
                  description: '| Request mode. Can only take the value `mobile`, which allows retrieving additional data in the array `result[ADDITIONAL_DATA]` ||'
                ACTIONS:
                  type: string
                  description: '| Operations available to the current user on the group ||'
                AVATAR:
                  type: string
                  description: '| URL of the group''s compressed user avatar ||'
                AVATAR_DATA:
                  type: string
                  description: '| Information about the group''s avatar ||'
                AVATAR_TYPES:
                  type: string
                  description: '| Types of avatars for groups ||'
                COUNTERS:
                  type: string
                  description: '| Number of unaccepted requests and invitations to join the group ||'
                DATE_CREATE:
                  type: string
                  description: '| Date and time of group creation in a more readable format ||'
                DEPARTMENTS:
                  type: string
                  description: '| Departments of employees added to the group ||'
                EFFICIENCY:
                  type: string
                  description: '| Group efficiency ||'
                FEATURES:
                  type: string
                  description: '| Available tools in the group specified in the advanced group settings ||'
                GROUP_MEMBERS_LIST:
                  type: string
                  description: '| List of active group members, invited users, and users awaiting confirmation to join the group ||'
                LIST_OF_MEMBERS:
                  type: string
                  description: '| List of group members with their information ||'
                LIST_OF_MEMBERS_AWAITING_INVITE:
                  type: string
                  description: '| Users awaiting confirmation to join the group ||'
                OWNER_DATA:
                  type: string
                  description: '| Data about the group owner ||'
                PIN:
                  type: string
                  description: '| Whether the group is pinned for the current user on the groups and projects page. Returned as `result[IS_PIN]` ||'
                PRIVACY_TYPE:
                  type: string
                  description: '| Group privacy level. Returned as `result[PRIVACY_CODE]` ||'
                SUBJECT_DATA:
                  type: string
                  description: '| Information about the group''s subject specified in the advanced group settings ||'
                TAGS:
                  type: string
                  description: '| Group tags specified in the advanced group settings ||'
                USER_DATA:
                  type: string
                  description: '| Data about the current user''s role in the group ||'
              required:
              - params
              - groupId
      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:
        - socialnetwork
  /socialnetwork.api.workgroup.list:
    post:
      summary: Get a List of Workgroups socialnetwork.api.workgroup.list
      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 `socialnetwork.api.workgroup.list` returns a list of workgroups, projects, scrums, and collaborations based on the current user's permissions.
      operationId: socialnetwork_api_workgroup_list
      tags:
      - Workgroups
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/sonet-group/socialnetwork-api-workgroup-list.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filter:
                  type: object
                  description: '| An object for filtering in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.'
                select:
                  type: array
                  items: {}
                  description: '| An array containing the list of fields to select.'
                order:
                  type: object
                  description: '| A sorting object in the format `{"field_1": "order_1", ..., "field_N": "order_N"}`.'
                params:
                  type: object
                  description: '| Additional request parameters ||'
                start:
                  type: integer
                  description: '| Pagination parameter.'
                ID:
                  type: integer
                  description: '| Group identifier ||'
                NAME:
                  type: string
                  description: '| Group name ||'
                OWNER_ID:
                  type: integer
                  description: '| Owner identifier ||'
                ACTIVE:
                  type: string
                  description: '| Group activity status: `Y` or `N` ||'
                VISIBLE:
                  type: string
                  description: '| Group visibility in the general list: `Y` or `N` ||'
                OPENED:
                  type: string
                  description: '| Is the group open for free membership: `Y` or `N` ||'
                CLOSED:
                  type: string
                  description: '| Is the group archived: `Y` or `N` ||'
                PROJECT:
                  type: string
                  description: '| Object type: `Y` — project, `N` — group ||'
                SUBJECT_ID:
                  type: integer
                  description: '| Group subject identifier ||'
                SITE_ID:
                  type: string
                  description: '| Group site identifier ||'
                DATE_CREATE:
                  type: string
                  format: date-time
                  description: '| Group creation date ||'
                DATE_UPDATE:
                  type: string
                  format: date-time
                  description: '| Group modification date ||'
                DATE_ACTIVITY:
                  type: string
                  format: date-time
                  description: '| Last activity date ||'
                DESCRIPTION:
                  type: string
                  description: '| Group description ||'
                KEYWORDS:
                  type: string
                  description: '| Group keywords ||'
                LANDING:
                  type: string
                  description: '| Group for publication status ||'
                IMAGE_ID:
                  type: integer
                  description: '| User avatar identifier ||'
                AVATAR_TYPE:
                  type: string
                  description: '| System avatar type ||'
                NUMBER_OF_MEMBERS:
                  type: integer
                  description: '| Number of participants ||'
                NUMBER_OF_MODERATORS:
                  type: integer
                  description: '| Number of moderators ||'
                INITIATE_PERMS:
                  type: string
                  description: '| Permissions to invite participants ||'
                PROJECT_DATE_START:
                  type: string
                  format: date-time
                  description: '| Project start date ||'
                PROJECT_DATE_FINISH:
                  type: string
                  format: date-time
                  description: '| Project end date ||'
                SCRUM_OWNER_ID:
                  type: integer
                  description: '| Scrum owner identifier ||'
                SCRUM_MASTER_ID:
                  type: integer
                  description: '| Scrum master identifier ||'
                SCRUM_SPRINT_DURATION:
                  type: integer
                  description: '| Sprint duration in seconds ||'
                SCRUM_TASK_RESPONSIBLE:
                  type: string
                  description: '| Default executor in scrum ||'
                TYPE:
                  type: string
                  description: '| Group type: `group`, `project`, `scrum`, `collab` ||'
                AVATAR:
                  type: string
                  description: '| Avatar URL ||'
                IS_ADMIN:
                  type: string
                  description: '| Disable permission check.'
                siteId:
                  type: string
                  description: '| Identifier of the site to be used in the automatic filter `SITE_ID` for regular users.'
                mode:
                  type: string
                  description: '| Response mode.'
                features:
                  type: array
                  items: {}
                  description: '| List of group tool codes to consider when forming `additionalData` in `mobile` mode ||'
                mandatoryFeatures:
                  type: array
                  items: {}
                  description: '| List of tool codes that should always be included in `additionalData` in `mobile` mode ||'
                shouldSelectDialogId:
                  type: string
                  description: '| Whether to add a field with the chat identifier `dialogId` to the list item.'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                filter:
                  type: object
                  description: '| An object for filtering in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.'
                select:
                  type: array
                  items: {}
                  description: '| An array containing the list of fields to select.'
                order:
                  type: object
                  description: '| A sorting object in the format `{"field_1": "order_1", ..., "field_N": "order_N"}`.'
                params:
                  type: object
                  description: '| Additional request parameters ||'
                start:
                  type: integer
                  description: '| Pagination parameter.'
                ID:
                  type: integer
                  description: '| Group identifier ||'
                NAME:
                  type: string
                  description: '| Group name ||'
                OWNER_ID:
                  type: integer
                  description: '| Owner identifier ||'
                ACTIVE:
                  type: string
                  description: '| Group activity status: `Y` or `N` ||'
                VISIBLE:
                  type: string
                  description: '| Group visibility in the general list: `Y` or `N` ||'
                OPENED:
                  type: string
                  description: '| Is the group open for free membership: `Y` or `N` ||'
                CLOSED:
                  type: string
                  description: '| Is the group archived: `Y` or `N` ||'
                PROJECT:
                  type: string
                  description: '| Object type: `Y` — project, `N` — group ||'
                SUBJECT_ID:
                  type: integer
                  description: '| Group subject identifier ||'
                SITE_ID:
                  type: string
                  description: '| Group site identifier ||'
                DATE_CREATE:
                  type: string
                  format: date-time
                  description: '| Group creation date ||'
                DATE_UPDATE:
                  type: string
                  format: date-time
                  description: '| Group modification date ||'
                DATE_ACTIVITY:
                  type: string
                  format: date-time
                  description: '| Last activity date ||'
                DESCRIPTION:
                  type: string
                  description: '| Group description ||'
                KEYWORDS:
                  type: string
                  description: '| Group keywords ||'
                LANDING:
                  type: string
                  description: '| Group for publication status ||'
                IMAGE_ID:
                  type: integer
                  description: '| User avatar identifier ||'
                AVATAR_TYPE:
                  type: string
                  description: '| System avatar type ||'
                NUMBER_OF_MEMBERS:
                  type: integer
                  description: '| Number of participants ||'
                NUMBER_OF_MODERATORS:
                  type: integer
                  description: '| Number of moderators ||'
                INITIATE_PERMS:
                  type: string
                  description: '| Permissions to invite participants ||'
                PROJECT_DATE_START:
                  type: string
                  format: date-time
                  description: '| Project start date ||'
                PROJECT_DATE_FINISH:
                  type: string
                  format: date-time
                  description: '| Project end date ||'
                SCRUM_OWNER_ID:
                  type: integer
                  description: '| Scrum owner identifier ||'
                SCRUM_MASTER_ID:
                  type: integer
                  description: '| Scrum master identifier ||'
                SCRUM_SPRINT_DURATION:
                  type: integer
                  description: '| Sprint duration in seconds ||'
                SCRUM_TASK_RESPONSIBLE:
                  type: string
                  description: '| Default executor in scrum ||'
                TYPE:
                  type: string
                  description: '| Group type: `group`, `project`, `scrum`, `collab` ||'
                AVATAR:
                  type: string
                  description: '| Avatar URL ||'
                IS_ADMIN:
                  type: string
                  description: '| Disable permission check.'
                siteId:
                  type: string
                  description: '| Identifier of the site to be used in the automatic filter `SITE_ID` for regular users.'
                mode:
                  type: string
                  description: '| Response mode.'
                features:
                  type: array
                  items: {}
                  description: '| List of group tool codes to consider when forming `additionalData` in `mobile` mode ||'
                mandatoryFeatures:
                  type: array
                  items: {}
                  description: '| List of tool codes that should always be included in `additionalData` in `mobile` mode ||'
                shouldSelectDialogId:
                  type: string
                  description: '| Whether to add a field with the chat identifier `dialogId` to the list item.'
      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:
        - socialnetwork
  /tasks.api.scrum.backlog.add:
    post:
      summary: Add backlog in Scrum tasks.api.scrum.backlog.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 `tasks.api.scrum.backlog.add` adds a backlog in Scrum. It may be necessary to create a backlog during import after creating the Scrum.
      operationId: tasks_api_scrum_backlog_add
      tags:
      - Workgroups
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  description: '| An object containing records about the group and user (detailed description provided below) in the following structure:'
                groupId:
                  type: integer
                  description: '| The identifier of the group for which the backlog is created.'
                createdBy:
                  type: integer
                  description: '| The identifier of the user who will create the backlog ||'
                modifiedBy:
                  type: integer
                  description: '| The identifier of the user who will modify the backlog ||'
              required:
              - fields
              - groupId
              - createdBy
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  description: '| An object containing records about the group and user (detailed description provided below) in the following structure:'
                groupId:
                  type: integer
                  description: '| The identifier of the group for which the backlog is created.'
                createdBy:
                  type: integer
                  description: '| The identifier of the user who will create the backlog ||'
                modifiedBy:
                  type: integer
                  description: '| The identifier of the user who will modify the backlog ||'
              required:
              - fields
              - groupId
              - createdBy
      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:
        - task
  /tasks.api.scrum.backlog.delete:
    post:
      summary: Delete backlog tasks.api.scrum.backlog.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 `tasks.api.scrum.backlog.delete` removes the backlog. In normal circumstances, there is no need to delete the backlog. When the backlog is deleted, *Bitrix24* will automatically recreate it when the planning page in Scrum tasks is opened. The method is used if the backlog was mistakenly added to a group or project that is not Scrum.
      operationId: tasks_api_scrum_backlog_delete
      tags:
      - Workgroups
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-delete.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Backlog identifier.'
              required:
              - id
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Backlog identifier.'
              required:
              - 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:
        - task
  /tasks.api.scrum.backlog.get:
    post:
      summary: Get Backlog Fields by Scrum ID tasks.api.scrum.backlog.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 `tasks.api.scrum.backlog.get` returns the values of backlog fields by Scrum `id`. You may need to obtain the `id` of the backlog to add or move a task to the backlog.
      operationId: tasks_api_scrum_backlog_get
      tags:
      - Workgroups
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Identifier of the group.'
              required:
              - id
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: '| Identifier of the group.'
              required:
              - 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:
        - task
  /tasks.api.scrum.backlog.getFields:
    post:
      summary: Get a list of available backlog fields tasks.api.scrum.backlog.getFields
      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 `tasks.api.scrum.backlog.getFields` returns the available backlog fields. Without parameters.
      operationId: tasks_api_scrum_backlog_getFields
      tags:
      - Workgroups
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/sonet-group/scrum/backlog/tasks-api-scrum-backlog-get-fields.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                groupId:
                  type: integer
                  description: '| Identifier of the group for which the backlog was created ||'
                createdBy:
                  type: integer
                  description: '| Identifier of the user who created the backlog ||'
                modifiedBy:

# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-workgroups-api-openapi.yml