#Entity reference
Complete list of entities and specialized APIs with their available operations. Each entity lists its path, operation set, and required scope. The common request and response format is described in API overview.
#Entities by section
#CRM
| Entity |
Path |
Operations |
Scope |
| Deals |
/v1/deals |
list get create update delete fields search aggregate products |
crm |
| Contacts |
/v1/contacts |
list get create update delete fields search aggregate |
crm |
| Companies |
/v1/companies |
list get create update delete fields search aggregate |
crm |
| Leads |
/v1/leads |
list get create update delete fields search aggregate products |
crm |
| Quotes |
/v1/quotes |
list get create update delete fields search aggregate products |
crm |
| Invoices |
/v1/invoices |
list get create update delete fields search aggregate products |
crm |
| Deal categories |
/v1/deal-categories |
list get create update delete fields search aggregate |
crm |
| Activities |
/v1/activities |
list get create update delete fields search aggregate |
crm |
| CRM products |
/v1/products |
list get create update delete fields search aggregate |
crm |
| Product sections |
/v1/product-sections |
list get create update delete fields search aggregate |
crm |
| Statuses and stages |
/v1/statuses |
list get create update delete fields search aggregate |
crm |
| Currencies |
/v1/currencies |
list get create update delete fields search aggregate |
crm |
| Requisites |
/v1/requisites |
list get create update delete fields search aggregate |
crm |
| Requisite presets |
/v1/requisite-presets |
list get create update delete fields search aggregate |
crm |
| Bank details |
/v1/bank-details |
list get create update delete fields search aggregate |
crm |
| Addresses (composite key) |
/v1/addresses, /v1/addresses/:typeId/:entityTypeId/:entityId |
list get create update delete fields |
crm |
| Preset fields (nested) |
/v1/requisite-presets/:presetId/fields |
list get create update delete available schema |
crm |
| Requisite links |
/v1/requisite-links, /v1/requisite-links/:entityTypeId/:entityId |
list get register unregister fields |
crm |
| Timelines |
/v1/timelines |
list get create update delete fields search aggregate |
crm |
#Smart processes
| Entity |
Path |
Operations |
Scope |
| Smart processes |
/v1/smart-processes |
list get create update delete fields search |
crm |
| Smart process items |
/v1/items/:entityTypeId |
list get create update delete fields search aggregate products |
crm |
#Tasks
| Entity |
Path |
Operations |
Scope |
| Tasks |
/v1/tasks |
list get create update delete fields search aggregate |
tasks |
| Task comments |
/v1/tasks/:taskId/comments |
list get create update delete |
task |
| Task time tracking |
/v1/tasks/:taskId/time |
list get create update delete |
task |
#Calendar
| Entity |
Path |
Operations |
Scope |
| Calendar events |
/v1/calendar-events |
list get create update delete fields |
calendar |
#Drive
| Entity |
Path |
Operations |
Scope |
| Files |
/v1/files |
list get update delete fields search aggregate |
disk |
| Folders |
/v1/folders |
list get create update delete fields search aggregate |
disk |
| Storages |
/v1/storages |
list get fields search aggregate |
disk |
#Users and social network
| Entity |
Path |
Operations |
Scope |
| Users |
/v1/users |
list get create invite update delete fields search aggregate |
user |
| Departments |
/v1/departments |
list get create update delete fields search |
department |
| Workgroups |
/v1/workgroups |
list get create update delete search fields |
sonet_group |
#Trade catalog
| Entity |
Path |
Operations |
Scope |
| Catalogs |
/v1/catalogs |
list get search fields |
catalog |
| Catalog products |
/v1/catalog-products |
list get create update delete fields search aggregate |
catalog |
| Catalog sections |
/v1/catalog-sections |
list get create update delete search aggregate |
catalog |
| Catalog prices |
/v1/catalog-prices |
list get create update delete search fields |
catalog |
| Warehouses |
/v1/warehouses |
list get create update delete stock |
catalog |
#Online store
| Entity |
Path |
Operations |
Scope |
| Orders |
/v1/orders |
list get create update delete fields search aggregate |
sale |
| Payments |
/v1/payments |
list get create update delete search aggregate |
sale |
| Basket items |
/v1/basket-items |
list get create update delete search aggregate |
sale |
| Order statuses |
/v1/order-statuses |
list get create update delete search aggregate |
sale |
#Sites
| Entity |
Path |
Operations |
Scope |
| Sites |
/v1/sites |
list get create update delete search aggregate |
landing |
| Pages |
/v1/pages |
list get create update delete search |
landing |
#Document generator
| Entity |
Path |
Operations |
Scope |
| Document templates |
/v1/doc-templates |
list get create update delete fields search |
documentgenerator |
| Documents |
/v1/documents |
list get create update delete fields search |
documentgenerator |
#Booking
| Entity |
Path |
Operations |
Scope |
| Bookings |
/v1/bookings |
list get create update delete search |
booking |
#Business processes
| Entity |
Path |
Operations |
Scope |
| Business process templates |
/v1/bizproc-templates |
list create update delete search aggregate |
bizproc |
| Business process activities |
/v1/bizproc-activities |
list create update delete search aggregate |
bizproc |
| Robots |
/v1/bizproc-robots |
list create update delete search aggregate |
bizproc |
#Open Channels
| Entity |
Path |
Operations |
Scope |
| Open Channel configs |
/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 |
| Business processes |
/v1/workflows |
bizproc |
Launch, list, terminate processes, events |
| Notifications |
/v1/notifications |
im |
Push notifications to Bitrix24 users |
| 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 |
Activity stream: announcements, comments |
| Custom fields |
/v1/userfields |
crm |
CRM custom fields: deals, leads, contacts, companies, quotes |
| Stage history |
/v1/stage-history |
crm |
History of CRM stage transitions |
| Duplicates |
/v1/duplicates |
crm |
Find duplicates by phone/email |
| 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:
?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):
?include=company,contact loads related entities in a single request