# Entity reference

Complete list of entities and specialized APIs with their available operations. Each entry lists the path, operation set, and required scope. The common request and response format is described in [API overview](/docs/entity-api).

## Entities by section

### CRM

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Deals](/docs/entities/deals) | `/v1/deals` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Contacts](/docs/entities/contacts) | `/v1/contacts` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Companies](/docs/entities/companies) | `/v1/companies` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Leads](/docs/entities/leads) | `/v1/leads` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Quotes](/docs/entities/quotes) | `/v1/quotes` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Invoices](/docs/entities/invoices) | `/v1/invoices` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |
| [Sales pipelines](/docs/entities/deal-categories) | `/v1/deal-categories` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Pipelines](/docs/entities/categories) | `/v1/categories/:entityTypeId` | `list` `get` `create` `update` `delete` `fields` | `crm` |
| [Activities](/docs/entities/activities) | `/v1/activities` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Activity bindings](/docs/entities/activities/bindings) | `/v1/activities/:activityId/bindings` | `list` `bind` `unbind` `move` | `crm` |
| [Configurable activities](/docs/entities/activities/configurable) | `/v1/activity-configurable` | `create` `get` `update` | `crm` |
| [CRM call transcripts](/docs/entities/activities/transcript) | `/v1/activities/:activityId/transcript` | `get` | `crm` |
| [CRM products](/docs/entities/products) | `/v1/products` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Product sections](/docs/entities/product-sections) | `/v1/product-sections` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Statuses and stages](/docs/entities/statuses) | `/v1/statuses` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Currencies](/docs/entities/currencies) | `/v1/currencies` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Requisites](/docs/entities/requisites) | `/v1/requisites` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `crm` |
| [Requisite presets](/docs/entities/requisite-presets) | `/v1/requisite-presets` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Bank details](/docs/entities/bank-details) | `/v1/bank-details` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Addresses](/docs/entities/addresses) | `/v1/addresses`, `/v1/addresses/:typeId/:entityTypeId/:entityId` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Requisite links](/docs/entities/requisite-links) | `/v1/requisite-links`, `/v1/requisite-links/:entityTypeId/:entityId` | `list` `get` `register` `unregister` `fields` `search` | `crm` |
| [Timeline comments](/docs/entities/timelines) | `/v1/timelines` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [CRM card layout](/docs/entities/crm-card-config) | `/v1/crm/card-config/:entityTypeId` | `get` `set` `reset` `force-common` | `crm` |

### Smart processes

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Smart processes](/docs/entities/smart-processes) | `/v1/smart-processes` | `list` `get` `create` `update` `delete` `fields` `search` | `crm` |
| [Smart process items](/docs/entities/items) | `/v1/items/:entityTypeId` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` `products` | `crm` |

### Tasks

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Tasks](/docs/entities/tasks) | `/v1/tasks` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `tasks` |
| [Task comments](/docs/entities/task-comments) | `/v1/tasks/:taskId/comments` | `list` `get` `create` `update` `delete` | `task` |
| [Task time tracking](/docs/entities/tasks/time) | `/v1/tasks/:taskId/time` | `list` `get` `create` `update` `delete` | `task` |
| [Task chat](/docs/entities/tasks/chat) | `/v1/tasks/:taskId/chat/messages` | `get` | `task` |
| [Task change history](/docs/task-history) | `/v1/tasks/:taskId/history` | `get` | `task` |
| [Task kanban stages](/docs/task-stages) | `/v1/tasks/stages/:entityId` | `get` | `task` |
| [Scrum (epics + placement)](/docs/scrum) | `/v1/scrum/epics`, `/v1/scrum/tasks/:taskId` | `list` `get` `create` `update` | `task` |

### Calendar

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Calendar events](/docs/entities/calendar-events) | `/v1/calendar-events` | `list` `get` `create` `update` `delete` `fields` | `calendar` |

### Drive

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Files](/docs/entities/files) | `/v1/files` | `list` `get` `update` `delete` `fields` `search` `upload` `download` `moveto` `copyto` | `disk` |
| [Folders](/docs/entities/folders) | `/v1/folders` | `list` `get` `create` `update` `delete` `fields` `search` | `disk` |
| [Storages](/docs/entities/storages) | `/v1/storages` | `list` `get` `fields` `search` | `disk` |

### Users and social network

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Employees](/docs/entities/users) | `/v1/users` | `list` `get` `create` `invite` `update` `delete` `fields` `search` `aggregate` | `user` |
| [Departments](/docs/entities/departments) | `/v1/departments` | `list` `get` `create` `update` `delete` `fields` `search` | `department` |
| [Workgroups](/docs/entities/workgroups) | `/v1/workgroups` | `list` `get` `create` `update` `delete` `search` `fields` | `sonet_group` |

### Trade catalog

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Catalogs](/docs/entities/catalogs) | `/v1/catalogs` | `list` `get` `search` `fields` | `catalog` |
| [Catalog products](/docs/entities/catalog-products) | `/v1/catalog-products` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `catalog` |
| [Catalog product properties](/docs/entities/catalog-product-properties) | `/v1/catalog-product-properties` | `list` `get` `create` `update` `delete` `search` `fields` | `catalog` |
| [Catalog sections](/docs/entities/catalog-sections) | `/v1/catalog-sections` | `list` `get` `create` `update` `delete` `search` `aggregate` | `catalog` |
| [Catalog prices](/docs/entities/catalog-prices) | `/v1/catalog-prices` | `list` `get` `create` `update` `delete` `search` `fields` | `catalog` |
| [Warehouses](/docs/entities/warehouses) | `/v1/warehouses` | `list` `get` `create` `update` `delete` `stock` | `catalog` |

### Online store

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Orders](/docs/entities/orders) | `/v1/orders` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `sale` |
| [Payments](/docs/entities/payments) | `/v1/payments` | `list` `get` `create` `update` `delete` `search` `aggregate` | `sale` |
| [Basket items](/docs/entities/basket-items) | `/v1/basket-items` | `list` `get` `create` `update` `delete` `search` `aggregate` | `sale` |
| [Order statuses](/docs/entities/order-statuses) | `/v1/order-statuses` | `list` `get` `create` `update` `delete` `search` `aggregate` | `sale` |

### Sites

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Sites](/docs/entities/sites) | `/v1/sites` | `list` `get` `create` `update` `delete` `search` `fields` `aggregate` | `landing` |
| [Pages](/docs/entities/pages) | `/v1/pages` | `list` `get` `create` `update` `delete` `search` `fields` `aggregate` | `landing` |

### Document generator

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Document templates](/docs/entities/doc-templates) | `/v1/doc-templates` | `list` `get` `create` `update` `delete` `fields` `search` `aggregate` | `documentgenerator` |
| [Documents](/docs/entities/documents) | `/v1/documents` | `list` `get` `create` `update` `delete` `fields` `search` | `documentgenerator` |
| [Documents by CRM record](/docs/entities/documents/crm-list) | `/v1/crm-documents` | `list` | `crm` |

### Booking

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Bookings](/docs/entities/bookings) | `/v1/bookings` | `list` `get` `create` `update` `delete` `search` `fields` | `booking` |

### Business processes

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Business process templates](/docs/entities/bizproc-templates) | `/v1/bizproc-templates` | `list` `create` `update` `delete` `fields` `search` | `bizproc` |
| [Business process activities](/docs/entities/bizproc-activities) | `/v1/bizproc-activities` | `list` `create` `update` `delete` `fields` | `bizproc` |
| [Automation rules](/docs/entities/bizproc-robots) | `/v1/bizproc-robots` | `list` `create` `update` `delete` `fields` | `bizproc` |

### Open Channels

| Entity | Path | Operations | Scope |
|----------|------|----------|-------|
| [Open Channel configurations](/docs/openlines/config) | `/v1/openline-configs` | `list` `get` `create` `update` `delete` `search` `fields` `aggregate` | `imopenlines` |

## Specialized APIs

These APIs have their own endpoints that go beyond standard CRUD:

| API | Path | Scope | Description |
|-----|------|-------|----------|
| Bots | `/v1/bots` | `imbot` | Bot platform (imbot.v2): registration, messages, chats, commands, files |
| Chats | `/v1/chats` | `im` | IM Chat API: CRM entity chats, messages, group chats |
| Workflows | `/v1/workflows` | `bizproc` | Launch, list, terminate processes, events |
| [Notifications](/docs/notifications) | `/v1/notifications` | `im` | Notifications to Bitrix24 users |
| [Telephony](/docs/telephony) | `/v1/calls`, `/v1/telephony-lines`, `/v1/voximplant-lines` | `telephony` | Registering external calls in CRM, outbound calls, lines, statistics |
| Triggers | `/v1/triggers` | `crm` | CRM automation triggers: fire a trigger on a deal/lead |
| Timeline log | `/v1/timeline-logs` | `crm` | CRM timeline: actions, notes, pinning, binding to entities |
| Posts | `/v1/posts` | `log` | Feed: announcements, comments |
| User fields | `/v1/userfields` | `crm` | CRM user fields: deals, leads, contacts, companies, quotes |
| [Stage history](/docs/stage-history) | `/v1/stage-history` | `crm` | History of CRM stage transitions |
| [Duplicates](/docs/duplicates) | `/v1/duplicates/find` | `crm` | Find duplicates by phone/email |
| [Scrum](/docs/scrum) | `/v1/scrum` | `task` | Scrum epics + task placement: create/rename epics, bind tasks to epics, auto-backlog |
| [Task chat](/docs/entities/tasks/chat) | `/v1/tasks/:taskId/chat/messages` | `task` | Read the task chat from newest messages to oldest, cursor pagination. The key needs the `im` scope |
| [CRM call transcripts](/docs/entities/activities/transcript) | `/v1/activities/:activityId/transcript` | `crm` | Ready-made AI transcript of a client call by the call activity's `activityId` |
| Workday | `/v1/workday` | `timeman` | Work time tracking: open/close day, status, settings |
| Batch requests | `/v1/batch` | `*` | Up to 50 entity calls in a single request (1 rate-limit unit) |

## Common capabilities

All entity endpoints support:

- **[Filtering](/docs/filtering):** `?filter[stageId]=NEW` or `?filter[$gte][amount]=1000` (MongoDB operators)
- **Sorting:** `?sort=-createdAt` (`-` prefix for descending order)
- **Pagination:** `?limit=50&offset=100` (auto-pagination when limit > 50)
- **Field selection:** `?select=id,title,amount`
- **Field transformation:** camelCase names are automatically converted to Bitrix24 field names
- **Field metadata:** `GET /v1/{entity}/fields` returns field descriptions, including custom UF fields with labels. For enumeration fields, an `items` array with available values is returned
- **Search:** `POST /v1/{entity}/search` — advanced search with automatic date-based splitting for large data sets
- **Aggregation:** `POST /v1/{entity}/aggregate` — count, sum, average, minimum, maximum over fields
- **Product rows:** for CRM entities with products (deals, leads, quotes, invoices, smart process items), the routes `GET/POST/PUT/PATCH/DELETE /v1/{entity}/{id}/products` are available
- **[Related data (include)](/docs/includes):** `?include=company,contact` loads related entities in a single request