How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitrix24 Workgroups API

The Workgroups API from Bitrix24 — 39 operation(s) for workgroups.

Bitrix24 Workgroups API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workgroups. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 39 operations across 39 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

39 operations 39 paths 3 schemas 39 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Bitrix24 Workgroups API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 39

Across 39 paths, the API surfaces 39 operations — 39 POST. Each is listed below with its method, path, parameters, and response codes.

Workgroups 39
POST
/feature.access
Check the access permissions of the current user sonetgroup.feature.access
feature_access body → 2004XX
POST
/socialnetwork.api.workgroup.get
Retrieve Data on Workgroup socialnetwork.api.workgroup.get
socialnetwork_api_workgroup_get body → 2004XX
POST
/socialnetwork.api.workgroup.list
Get a List of Workgroups socialnetwork.api.workgroup.list
socialnetwork_api_workgroup_list body → 2004XX
POST
/tasks.api.scrum.backlog.add
Add backlog in Scrum tasks.api.scrum.backlog.add
tasks_api_scrum_backlog_add body → 2004XX
POST
/tasks.api.scrum.backlog.delete
Delete backlog tasks.api.scrum.backlog.delete
tasks_api_scrum_backlog_delete body → 2004XX
POST
/tasks.api.scrum.backlog.get
Get Backlog Fields by Scrum ID tasks.api.scrum.backlog.get
tasks_api_scrum_backlog_get body → 2004XX
POST
/tasks.api.scrum.backlog.getFields
Get a list of available backlog fields tasks.api.scrum.backlog.getFields
tasks_api_scrum_backlog_getFields body → 2004XX
POST
/tasks.api.scrum.backlog.update
Update backlog tasks.api.scrum.backlog.update
tasks_api_scrum_backlog_update body → 2004XX
POST
/tasks.api.scrum.epic.add
Add Epic in Scrum tasks.api.scrum.epic.add
tasks_api_scrum_epic_add body → 2004XX
POST
/tasks.api.scrum.epic.delete
Delete Epic tasks.api.scrum.epic.delete
tasks_api_scrum_epic_delete body → 2004XX
POST
/tasks.api.scrum.epic.get
Get Epic Fields by Its Identifier tasks.api.scrum.epic.get
tasks_api_scrum_epic_get body → 2004XX
POST
/tasks.api.scrum.epic.getFields
Get a list of available fields for epic tasks.api.scrum.epic.getFields
tasks_api_scrum_epic_getFields body → 2004XX
POST
/tasks.api.scrum.epic.list
Get a List of Epics tasks.api.scrum.epic.list
tasks_api_scrum_epic_list body → 2004XX
POST
/tasks.api.scrum.epic.update
Update Epic in Scrum tasks.api.scrum.epic.update
tasks_api_scrum_epic_update body → 2004XX
POST
/tasks.api.scrum.kanban.addStage
Create a Scrum Kanban Stage tasks.api.scrum.kanban.addStage
tasks_api_scrum_kanban_addStage body → 2004XX
POST
/tasks.api.scrum.kanban.addTask
Add Task to Scrum Kanban tasks.api.scrum.kanban.addTask
tasks_api_scrum_kanban_addTask body → 2004XX
POST
/tasks.api.scrum.kanban.deleteStage
Delete Stage tasks.api.scrum.kanban.deleteStage
tasks_api_scrum_kanban_deleteStage body → 2004XX
POST
/tasks.api.scrum.kanban.deleteTask
Delete Task from Scrum Kanban tasks.api.scrum.kanban.deleteTask
tasks_api_scrum_kanban_deleteTask body → 2004XX
POST
/tasks.api.scrum.kanban.getFields
Get a list of available fields for the kanban stage tasks.api.scrum.kanban.getFields
tasks_api_scrum_kanban_getFields body → 2004XX
POST
/tasks.api.scrum.kanban.getStages
Get Kanban Stages by Sprint ID tasks.api.scrum.kanban.getStages
tasks_api_scrum_kanban_getStages body → 2004XX
POST
/tasks.api.scrum.kanban.updateStage
Update Scrum Kanban Stage tasks.api.scrum.kanban.updateStage
tasks_api_scrum_kanban_updateStage body → 2004XX
POST
/tasks.api.scrum.sprint.add
Add Sprint in Scrum tasks.api.scrum.sprint.add
tasks_api_scrum_sprint_add body → 2004XX
POST
/tasks.api.scrum.sprint.complete
Complete the active sprint of the selected Scrum tasks.api.scrum.sprint.complete
tasks_api_scrum_sprint_complete body → 2004XX
POST
/tasks.api.scrum.sprint.delete
Delete Sprint tasks.api.scrum.sprint.delete
tasks_api_scrum_sprint_delete body → 2004XX
POST
/tasks.api.scrum.sprint.get
Get Sprint Fields by Its Identifier tasks.api.scrum.sprint.get
tasks_api_scrum_sprint_get body → 2004XX
POST
/tasks.api.scrum.sprint.getFields
Get a list of available fields for the sprint tasks.api.scrum.sprint.getFields
tasks_api_scrum_sprint_getFields body → 2004XX
POST
/tasks.api.scrum.sprint.list
Get the list of sprints tasks.api.scrum.sprint.list
tasks_api_scrum_sprint_list body → 2004XX
POST
/tasks.api.scrum.sprint.start
Start Sprint tasks.api.scrum.sprint.start
tasks_api_scrum_sprint_start body → 2004XX
POST
/tasks.api.scrum.sprint.update
Update Sprint tasks.api.scrum.sprint.update
tasks_api_scrum_sprint_update body → 2004XX
POST
/tasks.api.scrum.task.get
Get Scrum Task Fields by ID tasks.api.scrum.task.get
tasks_api_scrum_task_get body → 2004XX
POST
/tasks.api.scrum.task.getFields
Get Scrum Task Fields tasks.api.scrum.task.getFields
tasks_api_scrum_task_getFields body → 2004XX
POST
/tasks.api.scrum.task.update
Create or Update a Scrum Task tasks.api.scrum.task.update
tasks_api_scrum_task_update body → 2004XX
POST
/user.add
Add Users to Group sonetgroup.user.add
user_add body → 2004XX
POST
/user.delete
Remove users from group sonetgroup.user.delete
user_delete body → 2004XX
POST
/user.get
Get the list of group participants sonetgroup.user.get
user_get body → 2004XX
POST
/user.groups
Get the list of groups for the current user sonetgroup.user.groups
user_groups body → 2004XX
POST
/user.invite
Invite users to group sonetgroup.user.invite
user_invite body → 2004XX
POST
/user.request
Send a request to join the group sonetgroup.user.request
user_request body → 2004XX
POST
/user.update
Change Role of Group Participants sonetgroup.user.update
user_update body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-workgroups-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
Bitrix24 BIconnector API
Bitrix24 Business Processes API
Bitrix24 Calendar API
Bitrix24 Chatbots API
Bitrix24 Chats API
Bitrix24 Company Structure API
Bitrix24 CoPilot / AI API
Bitrix24 CRM API
Bitrix24 Data Storage API
Bitrix24 Deprecated Methods API
Bitrix24 Document Generator API
Where this information came from

This is an independent, third-party profile of Bitrix24 Workgroups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.