Главная / Документация / APIAPI: продажи, файлы, почта и остальные разделыМаршруты сделок, Диска, заметок, почты, календаря, закупок, отчетов, уведомлений и поиска volrix.pm: права, параметры, тела и примеры.Обновлено 27.09.2026Здесь собраны разделы, которые не относятся к проектам и документообороту напрямую: продажи (сделки, воронка, отчеты продаж), Диск с версиями и публичными ссылками, заметки, общий и личный почтовые ящики, календарь, закупки, готовые отчеты и конструктор отчетов, главная страница, уведомления, поиск и служебные справочники.**Что принимает API-ключ.** Сделки, Диск, заметки, общий почтовый ящик, закупки, отчеты и конструктор отчетов - по скоупам из таблиц. Личные разделы (моя почта, мой календарь, уведомления, настройки интерфейса), письма из системы, общий поиск и предпросмотр передачи сделки работают только в сессии.Базовый адрес, формат ответов и коды ошибок описаны в статье API: адрес, первый запрос и ответы, выпуск ключа и вход под пользователем - в статье API: вход, токен и API-ключи. В примерах ключ лежит в переменной окружения VOLRIX_API_KEY, токен пользователя - в VOLRIX_TOKEN.Типовой сценарий: передача выигранной сделки в проект

Проверьте сделку GET /api/v1/deals/{deal_id} (deals:read). В реализацию передаются только сделки в статусе won.

Посмотрите предпросмотр GET /api/v1/deals/{deal_id}/transfer-preview (сессия) - что перейдет в проект.

Передайте POST /api/v1/deals/{deal_id}/transfer с телом DealTransferIn (projects:create). Обязательны pm_id, start_date, end_date и document_set_id; carry_presale (по умолчанию true) переносит материалы пресейла.

Проверьте результат В ответе DealRead поле project_id указывает на созданный проект. Проект создается черновиком (draft), поэтому в GET /projects он виден только с include_drafts=true или only_drafts=true.

Примеры запросовОткрытые сделки на стадии переговоров по ключу (скоуп deals:read). Ответ - массив DealListItem:curl --fail-with-body -sS \ -H "X-Api-Key: $VOLRIX_API_KEY" \ "https://ваш-адрес/api/v1/deals?status=negotiation&include_closed=false"Загрузка файла в папку проекта на Диске по ключу (скоуп drive:create). Ответ NodeRead с id нового файла:curl --fail-with-body -sS -X POST \ -H "X-Api-Key: $VOLRIX_API_KEY" \ -F "file=@report.pdf" -F "space=project" -F "project_id=..." -F "parent_id=..." \ "https://ваш-адрес/api/v1/drive/files"Какие готовые отчеты видит владелец ключа - GET /api/v1/reports/visible-keys (reports:read). Открытые маршруты (публичная ссылка Диска /drive/public/{token}, заметка по ссылке /shared-notes/{token}) не требуют авторизации: доступ дает сам токен в адресе.МаршрутыКак читать колонку «Доступ»: **скоуп вида users:read** - маршрут принимает API-ключ, если в ключе есть этот скоуп, а у сотрудника, выпустившего ключ, есть такое же право в роли (users.read). Если скоупов несколько через «+», нужны все. **Только сессия** - нужен заголовок Authorization: Bearer, API-ключ получит 403. **Без авторизации** - заголовки не нужны. Доступ к конкретному объекту (участие в проекте, права на папку Диска) сервер проверяет дополнительно. Пути в таблицах указаны полностью, от корня сервера.Публичные аватары

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/avatars/{path}

path [path обяз.]: string

Без авторизации

200: object

Главная (дашборд)

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/dashboard/catalog

scope [query]: string (default=main)

Только сессия

200: object

GET /api/v1/dashboard/me

scope [query]: string (default=main)

Только сессия

200: object

PUT /api/v1/dashboard/me

scope [query]: string (default=main) | Тело: application/json: LayoutPayload

Только сессия

200: object

POST /api/v1/dashboard/me/reset

scope [query]: string (default=main)

Только сессия

200: object

GET /api/v1/dashboard/preset

scope [query]: string (default=main)

dashboard:manage

200: object

PUT /api/v1/dashboard/preset

scope [query]: string (default=main) | Тело: application/json: LayoutPayload

dashboard:manage

200: object

POST /api/v1/dashboard/run-widget

Нет | Тело: application/json: RunWidgetPayload

reports:read

200: object

Отчеты продаж

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/reports/deals/targets

year [query]: integer / null

deals:read

200: object

POST /api/v1/reports/deals/targets

Нет | Тело: application/json: TargetIn

deals:change_status

201: object

GET /api/v1/reports/deals/funnel

manager_id [query]: string (uuid) / null; date_from [query]: string (date) / null; date_to [query]: string (date) / null

deals:read

200: object

GET /api/v1/reports/deals

date_from [query]: string (date) / null; date_to [query]: string (date) / null; manager_id [query]: string (uuid) / null

deals:read

200: object

GET /api/v1/reports/deals/settings/stale-days

Нет

deals:read

200: StaleDays

PUT /api/v1/reports/deals/settings/stale-days

Нет | Тело: application/json: StaleDays

deals:manage_settings

200: StaleDays

Сделки

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/deal-loss-reasons

include_inactive [query]: boolean (default=false)

deal_loss_reasons:read

200: array[LossReasonRead]

GET /api/v1/organizations/{org_id}/contacts

org_id [path обяз.]: string (uuid)

contractors:read

200: array[ContactRead]

POST /api/v1/organizations/{org_id}/contacts

org_id [path обяз.]: string (uuid) | Тело: application/json: app__schemas__deal__ContactIn

contractors:update

201: ContactRead

DELETE /api/v1/organizations/{org_id}/contacts/{contact_id}

org_id [path обяз.]: string (uuid); contact_id [path обяз.]: string (uuid)

contractors:update

204

GET /api/v1/deals

status [query]: string / null; manager_id [query]: string (uuid) / null; customer_id [query]: string (uuid) / null; search [query]: string / null; include_closed [query]: boolean (default=true)

deals:read

200: array[DealListItem]

POST /api/v1/deals

Нет | Тело: application/json: DealCreate

deals:create

201: DealRead

GET /api/v1/deals/board

Нет

deals:read

200: object

GET /api/v1/deals/{deal_id}

deal_id [path обяз.]: string (uuid)

deals:read

200: DealRead

PUT /api/v1/deals/{deal_id}

deal_id [path обяз.]: string (uuid) | Тело: application/json: DealUpdate

deals:update

200: DealRead

POST /api/v1/deals/{deal_id}/status

deal_id [path обяз.]: string (uuid) | Тело: application/json: DealStatusChange

deals:change_status

200: DealRead

GET /api/v1/deals/{deal_id}/feed

deal_id [path обяз.]: string (uuid)

deals:read

200: object

GET /api/v1/deals/{deal_id}/stats

deal_id [path обяз.]: string (uuid)

deals:read

200: object

GET /api/v1/deals/{deal_id}/documents

deal_id [path обяз.]: string (uuid)

deals:read

200: object

POST /api/v1/deals/{deal_id}/meeting

deal_id [path обяз.]: string (uuid) | Тело: application/json: MeetingIn

deals:update

201: object

GET /api/v1/deals/{deal_id}/compose

deal_id [path обяз.]: string (uuid)

deals:read

200: object

GET /api/v1/deals/{deal_id}/stage-history

deal_id [path обяз.]: string (uuid)

deals:read

200: object

GET /api/v1/deals/{deal_id}/transfer-preview

deal_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/deals/{deal_id}/transfer

deal_id [path обяз.]: string (uuid) | Тело: application/json: DealTransferIn

projects:create

200: DealRead

POST /api/v1/deals/{deal_id}/folder

deal_id [path обяз.]: string (uuid)

drive:create

200: object

GET /api/v1/deals/{deal_id}/messages

deal_id [path обяз.]: string (uuid)

deals:read

200: object

POST /api/v1/deals/{deal_id}/quote

deal_id [path обяз.]: string (uuid); valid_days [query]: integer (default=30, min=1, max=365)

deals:update

200: object

GET /api/v1/deals/{deal_id}/contacts

deal_id [path обяз.]: string (uuid)

deals:read

200: object

POST /api/v1/deals/{deal_id}/contacts

deal_id [path обяз.]: string (uuid) | Тело: application/json: ContactRoleIn

deals:update

201: object

DELETE /api/v1/deals/{deal_id}/contacts/{row_id}

deal_id [path обяз.]: string (uuid); row_id [path обяз.]: string (uuid)

deals:update

204

GET /api/v1/deals/{deal_id}/contracts

deal_id [path обяз.]: string (uuid)

deals:read

200: object

POST /api/v1/deals/{deal_id}/contracts

deal_id [path обяз.]: string (uuid) | Тело: application/json: ContractLinkIn

deals:update

201: object

GET /api/v1/deals/{deal_id}/contracts/available

deal_id [path обяз.]: string (uuid)

deals:read

200: object

DELETE /api/v1/deals/{deal_id}/contracts/{contract_id}

deal_id [path обяз.]: string (uuid); contract_id [path обяз.]: string (uuid)

deals:update

204

POST /api/v1/deals/{deal_id}/team

deal_id [path обяз.]: string (uuid) | Тело: application/json: TeamMemberIn

deals:update

201: object

PUT /api/v1/deals/{deal_id}/team/{member_id}

deal_id [path обяз.]: string (uuid); member_id [path обяз.]: string (uuid) | Тело: application/json: TeamMemberIn

deals:update

200: object

DELETE /api/v1/deals/{deal_id}/team/{member_id}

deal_id [path обяз.]: string (uuid); member_id [path обяз.]: string (uuid)

deals:update

204

GET /api/v1/deals/{deal_id}/budget

deal_id [path обяз.]: string (uuid)

deals:read

200: object

POST /api/v1/deals/{deal_id}/budget/lines

deal_id [path обяз.]: string (uuid) | Тело: application/json: BudgetLineIn

deals:update

201: object

PUT /api/v1/deals/{deal_id}/budget/lines/{line_id}

deal_id [path обяз.]: string (uuid); line_id [path обяз.]: string (uuid) | Тело: application/json: BudgetLineIn

deals:update

200: object

DELETE /api/v1/deals/{deal_id}/budget/lines/{line_id}

deal_id [path обяз.]: string (uuid); line_id [path обяз.]: string (uuid)

deals:update

204

PATCH /api/v1/deals/{deal_id}/budget/lines/{line_id}/actual

deal_id [path обяз.]: string (uuid); line_id [path обяз.]: string (uuid) | Тело: application/json: object

deals:update

200: object

GET /api/v1/deals/{deal_id}/steps

deal_id [path обяз.]: string (uuid)

deals:read

200: array[DealStageStepRead]

POST /api/v1/deals/{deal_id}/steps

deal_id [path обяз.]: string (uuid) | Тело: application/json: DealStageStepIn

deals:update

201: DealStageStepRead

PATCH /api/v1/deal-steps/{step_id}

step_id [path обяз.]: string (uuid) | Тело: application/json: DealStageStepPatch

deals:update

200: DealStageStepRead

DELETE /api/v1/deal-steps/{step_id}

step_id [path обяз.]: string (uuid)

deals:update

204

GET /api/v1/deal-step-templates

Нет

deals:read

200: array[DealStepTemplateRead]

POST /api/v1/deal-step-templates

Нет | Тело: application/json: DealStepTemplateIn

deals:manage_settings

201: DealStepTemplateRead

PATCH /api/v1/deal-step-templates/{tpl_id}

tpl_id [path обяз.]: string (uuid) | Тело: application/json: DealStepTemplatePatch

deals:manage_settings

200: DealStepTemplateRead

DELETE /api/v1/deal-step-templates/{tpl_id}

tpl_id [path обяз.]: string (uuid)

deals:manage_settings

204

Диск

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/drive/spaces

Нет

drive:read

200: array[SpaceInfo]

GET /api/v1/drive/nodes

space [query]: string (default=personal); project_id [query]: string (uuid) / null; parent_id [query]: string / null; trashed [query]: boolean (default=false)

drive:read

200: array[NodeRead]

POST /api/v1/drive/folders

Нет | Тело: application/json: FolderCreate

drive:create

200: NodeRead

POST /api/v1/drive/tables

Нет | Тело: application/json: FolderCreate

drive:create

200: NodeRead

POST /api/v1/drive/documents

Нет | Тело: application/json: FolderCreate

drive:create

200: NodeRead

POST /api/v1/drive/files

Нет | Тело: multipart/form-data: Body_upload_file_api_v1_drive_files_post

drive:create

200: NodeRead

POST /api/v1/drive/nodes/{node_id}/versions

node_id [path обяз.]: string (uuid) | Тело: multipart/form-data: Body_upload_version_api_v1_drive_nodes__node_id__versions_post

drive:update

200: NodeRead

GET /api/v1/drive/nodes/{node_id}/versions

node_id [path обяз.]: string (uuid)

drive:read

200: array[VersionRead]

GET /api/v1/drive/nodes/{node_id}/download

node_id [path обяз.]: string (uuid)

drive:read

200: object

GET /api/v1/drive/versions/{version_id}/download

version_id [path обяз.]: string (uuid)

drive:read

200: object

POST /api/v1/drive/nodes/{node_id}/public

node_id [path обяз.]: string (uuid) | Тело: application/json: PublicShareIn / null

drive:share

200: object

DELETE /api/v1/drive/nodes/{node_id}/public

node_id [path обяз.]: string (uuid)

drive:share

200: object

GET /api/v1/drive/public/{token}

token [path обяз.]: string

Без авторизации

200: object

GET /api/v1/drive/public-links

Нет

drive:manage_all

200: object

POST /api/v1/drive/public-links/revoke

Нет | Тело: application/json: RevokeLinksIn

drive:manage_all

200: object

GET /api/v1/drive/public-links/policy

Нет

Только сессия

200: object

PUT /api/v1/drive/public-links/policy

Нет | Тело: application/json: PublicLinksPolicyIn

drive:manage_all

200: object

GET /api/v1/drive/activity

Нет

drive:read

200: array[ActivityItem]

GET /api/v1/drive/nodes/{node_id}/activity

node_id [path обяз.]: string (uuid)

drive:read

200: array[ActivityItem]

GET /api/v1/drive/trash

Нет

drive:read

200: array[SearchResult]

POST /api/v1/drive/trash/empty

space [query]: string (default=personal); project_id [query]: string (uuid) / null

drive:delete

200: object

GET /api/v1/drive/recent

Нет

drive:read

200: array[SearchResult]

GET /api/v1/drive/search

q [query]: string (default=); space [query]: string (default=personal); project_id [query]: string (uuid) / null; under_id [query]: string (uuid) / null

drive:read

200: array[SearchResult]

PATCH /api/v1/drive/nodes/{node_id}/type

node_id [path обяз.]: string (uuid) | Тело: application/json: TypeSet

drive:update

200: NodeRead

GET /api/v1/drive/document-kinds

Нет

drive:read

200: object

POST /api/v1/drive/nodes/{node_id}/copy

node_id [path обяз.]: string (uuid)

drive:create

200: NodeRead

GET /api/v1/drive/nodes/{node_id}/path

node_id [path обяз.]: string (uuid)

drive:read

200: object

PATCH /api/v1/drive/nodes/{node_id}

node_id [path обяз.]: string (uuid) | Тело: application/json: NodeRename

drive:update

200: NodeRead

DELETE /api/v1/drive/nodes/{node_id}

node_id [path обяз.]: string (uuid)

drive:delete

204

POST /api/v1/drive/nodes/{node_id}/move

node_id [path обяз.]: string (uuid) | Тело: application/json: NodeMove

drive:update

200: NodeRead

POST /api/v1/drive/nodes/{node_id}/trash

node_id [path обяз.]: string (uuid)

drive:delete

204

POST /api/v1/drive/nodes/{node_id}/restore

node_id [path обяз.]: string (uuid)

drive:delete

204

GET /api/v1/drive/nodes/{node_id}/acl

node_id [path обяз.]: string (uuid)

drive:read

200: AclSet

PUT /api/v1/drive/nodes/{node_id}/acl

node_id [path обяз.]: string (uuid) | Тело: application/json: AclSet

drive:share

204

Письма из системы

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/emails

status [query]: EmailMessageStatus / null

Только сессия

200: array[EmailMessageListItem]

POST /api/v1/emails

send [query]: boolean (default=false) | Тело: application/json: EmailMessageCreate

Только сессия

201: EmailMessageRead

GET /api/v1/emails/{email_id}

email_id [path обяз.]: string (uuid)

Только сессия

200: EmailMessageRead

PUT /api/v1/emails/{email_id}

email_id [path обяз.]: string (uuid) | Тело: application/json: EmailMessageUpdate

Только сессия

200: EmailMessageRead

DELETE /api/v1/emails/{email_id}

email_id [path обяз.]: string (uuid)

Только сессия

204

POST /api/v1/emails/{email_id}/send

email_id [path обяз.]: string (uuid)

Только сессия

200: EmailMessageRead

POST /api/v1/emails/{email_id}/files

email_id [path обяз.]: string (uuid) | Тело: multipart/form-data: Body_add_attachment_api_v1_emails__email_id__files_post

Только сессия

201: EmailAttachmentRead

DELETE /api/v1/emails/{email_id}/files/{attachment_id}

email_id [path обяз.]: string (uuid); attachment_id [path обяз.]: string (uuid)

Только сессия

204

Файлы по ссылке

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/files/download

path [query обяз.]: string

Только сессия

200: object

GET /api/v1/files/{full_path}

full_path [path обяз.]: string

Только сессия

200: object

Общий почтовый ящик

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/mailbox/settings

Нет

mailbox:read_settings

200: ImapSettings

PUT /api/v1/mailbox/settings

Нет | Тело: application/json: ImapSettingsUpdate

mailbox:update_settings

200: ImapSettings

POST /api/v1/mailbox/test-connection

Нет

mailbox:test_connection

200: ImapTestResponse

POST /api/v1/mailbox/fetch

Нет

mailbox:fetch

200: ImapFetchResponse

GET /api/v1/mailbox/shared-access/me

Нет

mailbox:read_messages

200: object

GET /api/v1/mailbox/messages/unread

Нет

mailbox:read_messages

200: object

GET /api/v1/mailbox/messages

status [query]: string / null; assigned_to_id [query]: string (uuid) / null; only_unassigned [query]: boolean (default=false); search [query]: string / null; account [query]: string / null; limit [query]: integer (default=20, min=1, max=500); offset [query]: integer (default=0, min=0)

mailbox:read_messages

200: MailboxMessageList

GET /api/v1/mailbox/messages/{message_id}

message_id [path обяз.]: string (uuid)

mailbox:read_messages

200: MailboxMessageDetail

POST /api/v1/mailbox/messages/{message_id}/reparse

message_id [path обяз.]: string (uuid)

mailbox:read_messages

200: MailboxMessageDetail

PATCH /api/v1/mailbox/messages/{message_id}/read

message_id [path обяз.]: string (uuid) | Тело: application/json: ReadFlagIn

mailbox:read_messages

200: object

PATCH /api/v1/mailbox/messages/{message_id}/assign

message_id [path обяз.]: string (uuid) | Тело: application/json: MailboxAssignRequest

mailbox:manage_messages

200: MailboxMessageDetail

PATCH /api/v1/mailbox/messages/{message_id}/status

message_id [path обяз.]: string (uuid) | Тело: application/json: MailboxStatusRequest

mailbox:manage_messages

200: MailboxMessageDetail

POST /api/v1/mailbox/messages/bulk-delete

Нет | Тело: application/json: BulkDeleteRequest

mailbox:manage_messages

200: object

POST /api/v1/mailbox/messages/{message_id}/convert

message_id [path обяз.]: string (uuid) | Тело: application/json: ConvertRequest

mailbox:convert

200: ConvertResponse

POST /api/v1/mailbox/image-proxy/sign

Нет | Тело: application/json: SignImagesRequest

mailbox:read_messages

200: object

GET /api/v1/mailbox/image-proxy

u [query обяз.]: string; exp [query обяз.]: integer; sig [query обяз.]: string

Без авторизации

200: object

GET /api/v1/mailbox/blocklist

Нет

mailbox:read_messages

200: object

POST /api/v1/mailbox/blocklist

Нет | Тело: application/json: BlockRuleIn

mailbox:manage_messages

201: object

DELETE /api/v1/mailbox/blocklist/{rule_id}

rule_id [path обяз.]: string (uuid)

mailbox:manage_messages

204

POST /api/v1/mailbox/messages/{message_id}/spam

message_id [path обяз.]: string (uuid)

mailbox:manage_messages

200: object

GET /api/v1/mailbox/nav-counters

Нет

Только сессия

200: object

Мой календарь

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/me/calendars

Нет

Только сессия

200: array[CalendarRead]

PATCH /api/v1/me/calendars/{calendar_id}

calendar_id [path обяз.]: string (uuid) | Тело: application/json: CalendarPatch

Только сессия

200: CalendarRead

GET /api/v1/me/calendar/events

start [query]: string (date-time) / null; end [query]: string (date-time) / null; account [query]: string / null; calendars [query]: string / null

Только сессия

200: object

GET /api/v1/me/calendar/events/{event_id}

event_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/me/calendar/sync

Нет

Только сессия

200: object

POST /api/v1/me/calendar/accounts/{account_id}/password

account_id [path обяз.]: string (uuid) | Тело: application/json: CalendarPasswordIn

Только сессия

200: object

POST /api/v1/me/calendar/accounts/{account_id}/sync

account_id [path обяз.]: string (uuid)

Только сессия

200: object

GET /api/v1/me/calendar/link-targets

Нет

Только сессия

200: object

GET /api/v1/me/calendar/events/{event_id}/links

event_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/me/calendar/events/{event_id}/links

event_id [path обяз.]: string (uuid) | Тело: application/json: app__routers__my_calendar__LinkIn

Только сессия

201: object

DELETE /api/v1/me/calendar/events/{event_id}/links/{link_id}

event_id [path обяз.]: string (uuid); link_id [path обяз.]: string (uuid)

Только сессия

204

Моя почта

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/me/mail-providers

Нет

Только сессия

200: object

POST /api/v1/me/mail-accounts/oauth/start

Нет | Тело: application/json: OAuthStartIn

Только сессия

200: object

POST /api/v1/me/mail-accounts/oauth/finish

Нет | Тело: application/json: OAuthFinishIn

Только сессия

200: MailAccountRead

GET /api/v1/me/mail-accounts

Нет

Только сессия

200: array[MailAccountRead]

POST /api/v1/me/mail-accounts

Нет | Тело: application/json: MailAccountIn

Только сессия

201: MailAccountRead

PUT /api/v1/me/mail-accounts/{account_id}

account_id [path обяз.]: string (uuid) | Тело: application/json: MailAccountIn

Только сессия

200: MailAccountRead

DELETE /api/v1/me/mail-accounts/{account_id}

account_id [path обяз.]: string (uuid)

Только сессия

204

POST /api/v1/me/mail-accounts/{account_id}/default

account_id [path обяз.]: string (uuid)

Только сессия

200: MailAccountRead

POST /api/v1/me/mail-accounts/{account_id}/services

account_id [path обяз.]: string (uuid) | Тело: application/json: ServicesIn

Только сессия

200: MailAccountRead

POST /api/v1/me/mail-accounts/{account_id}/test

account_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/me/mail-accounts/{account_id}/history

account_id [path обяз.]: string (uuid); count [query]: integer (default=50)

Только сессия

200: object

POST /api/v1/me/mail-accounts/{account_id}/fetch

account_id [path обяз.]: string (uuid)

Только сессия

200: object

GET /api/v1/me/mail/link-targets

Нет

Только сессия

200: object

GET /api/v1/me/mail/messages/{message_id}/links

message_id [path обяз.]: string (uuid)

Только сессия

200: object

POST /api/v1/me/mail/messages/{message_id}/links

message_id [path обяз.]: string (uuid) | Тело: application/json: app__routers__my_mail__LinkIn

Только сессия

201: object

DELETE /api/v1/me/mail/messages/{message_id}/links/{link_id}

message_id [path обяз.]: string (uuid); link_id [path обяз.]: string (uuid)

Только сессия

204

GET /api/v1/me/mail/messages/{message_id}/suggest-deals

message_id [path обяз.]: string (uuid)

Только сессия

200: object

Заметки

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/notes/folders

Нет

notes:read

200: array[NoteFolderOut]

POST /api/v1/notes/folders

Нет | Тело: application/json: NoteFolderCreate

notes:write

201: NoteFolderOut

PATCH /api/v1/notes/folders/{folder_id}

folder_id [path обяз.]: string (uuid) | Тело: application/json: NoteFolderUpdate

notes:write

200: NoteFolderOut

DELETE /api/v1/notes/folders/{folder_id}

folder_id [path обяз.]: string (uuid)

notes:write

204

GET /api/v1/notes

q [query]: string / null; folder_id [query]: string (uuid) / null; no_folder [query]: boolean (default=false); tag [query]: string / null; favorites [query]: boolean (default=false); templates [query]: boolean (default=false); archived [query]: boolean (default=false); page [query]: integer (default=1, min=1); page_size [query]: integer (default=50, min=1, max=200)

notes:read

200: NoteListOut

POST /api/v1/notes

Нет | Тело: application/json: NoteCreate

notes:write

201: NoteOut

GET /api/v1/notes/tags

Нет

notes:read

200: array[TagCount]

GET /api/v1/notes/templates

Нет

notes:read

200: array[NoteListItem]

GET /api/v1/notes/graph

entities [query]: boolean (default=true)

notes:read

200: GraphOut

GET /api/v1/notes/suggest

kind [query]: string (default=note); q [query]: string (default=); limit [query]: integer (default=10, min=1, max=25)

notes:read

200: array[SuggestItem]

GET /api/v1/notes/for-entity/{kind}/{entity_id}

kind [path обяз.]: string; entity_id [path обяз.]: string (uuid)

notes:read

200: array[NoteListItem]

GET /api/v1/notes/daily

day [query]: string (date) / null

notes:write

200: NoteOut

GET /api/v1/notes/export

Нет

notes:read

200: object

POST /api/v1/notes/import

Нет | Тело: multipart/form-data: Body_import_notes_api_v1_notes_import_post

notes:write

200: ImportReport

GET /api/v1/notes/shared-with-me

Нет

notes:read

200: array[SharedNoteItem]

GET /api/v1/notes/{note_id}

note_id [path обяз.]: string (uuid)

notes:read

200: NoteOut

PATCH /api/v1/notes/{note_id}

note_id [path обяз.]: string (uuid) | Тело: application/json: NoteUpdate

notes:write

200: NoteOut

DELETE /api/v1/notes/{note_id}

note_id [path обяз.]: string (uuid)

notes:write

204

POST /api/v1/notes/{note_id}/archive

note_id [path обяз.]: string (uuid); archived [query]: boolean (default=true)

notes:write

200: NoteOut

GET /api/v1/notes/{note_id}/export/{fmt}

note_id [path обяз.]: string (uuid); fmt [path обяз.]: string

notes:read

200: object

GET /api/v1/notes/{note_id}/public

note_id [path обяз.]: string (uuid)

notes:read

200: NotePublicOut

PUT /api/v1/notes/{note_id}/public

note_id [path обяз.]: string (uuid) | Тело: application/json: NotePublicIn

notes:write

200: NotePublicOut

GET /api/v1/notes/{note_id}/shares

note_id [path обяз.]: string (uuid)

notes:read

200: array[NoteShareOut]

POST /api/v1/notes/{note_id}/shares

note_id [path обяз.]: string (uuid) | Тело: application/json: NoteShareIn

notes:write

201: NoteShareOut

DELETE /api/v1/notes/{note_id}/shares/{person_id}

note_id [path обяз.]: string (uuid); person_id [path обяз.]: string (uuid)

notes:write

204

Заметки по публичной ссылке

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/shared-notes/{token}

token [path обяз.]: string; pin [query]: string / null

Без авторизации

200: PublicNoteOut

GET /api/v1/shared-notes/{token}/export/{fmt}

token [path обяз.]: string; fmt [path обяз.]: string; pin [query]: string / null

Без авторизации

200: object

Уведомления

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/notifications

only_unread [query]: boolean (default=false); page [query]: integer (default=1, min=1); page_size [query]: integer (default=20, min=1, max=100)

Только сессия

200: NotificationList

DELETE /api/v1/notifications

only_read [query]: boolean (default=false)

Только сессия

200: object

GET /api/v1/notifications/unread-count

Нет

Только сессия

200: UnreadCount

PATCH /api/v1/notifications/{notification_id}/read

notification_id [path обяз.]: string (uuid)

Только сессия

200: NotificationRead

POST /api/v1/notifications/mark-all-read

Нет

Только сессия

200: object

GET /api/v1/notifications/settings

Нет

Только сессия

200: NotificationSettingsRead

PUT /api/v1/notifications/settings

Нет | Тело: application/json: NotificationSettingsUpdate

Только сессия

200: NotificationSettingsRead

POST /api/v1/notifications/settings/email

Нет | Тело: application/json: NotifyEmailSet

Только сессия

200: NotificationSettingsRead

POST /api/v1/notifications/settings/email/confirm

Нет | Тело: application/json: NotifyEmailConfirm

Только сессия

200: NotificationSettingsRead

POST /api/v1/notifications/settings/email/test

Нет

Только сессия

200: NotifyEmailTestResult

POST /api/v1/notifications/telegram/link

Нет

Только сессия

200: TelegramLinkStart

POST /api/v1/notifications/telegram/verify

Нет

Только сессия

200: TelegramLinkStatus

POST /api/v1/notifications/telegram/unlink

Нет

Только сессия

200: TelegramLinkStatus

Презентации

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

POST /api/v1/presentation-builder/export

Нет | Тело: application/json: BuilderRequest

report_builder:manage

200: object

POST /api/v1/presentation-builder/project/{project_id}/from-template

project_id [path обяз.]: string (uuid)

projects:read

200: object

Закупки

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/purchase-requests

project_id [query]: string (uuid) / null; deal_id [query]: string (uuid) / null; status [query]: PurchaseRequestStatus / null; active_only [query]: boolean (default=false)

purchases:read

200: object

POST /api/v1/purchase-requests

Нет | Тело: application/json: RequestIn

purchases:create

200: object

GET /api/v1/purchase-requests/{request_id}

request_id [path обяз.]: string (uuid)

purchases:read

200: object

PATCH /api/v1/purchase-requests/{request_id}

request_id [path обяз.]: string (uuid) | Тело: application/json: RequestPatch

purchases:update

200: object

DELETE /api/v1/purchase-requests/{request_id}

request_id [path обяз.]: string (uuid)

purchases:delete

200: object

POST /api/v1/purchase-requests/{request_id}/status

request_id [path обяз.]: string (uuid) | Тело: application/json: StatusIn

purchases:update

200: object

POST /api/v1/purchase-requests/{request_id}/folder

request_id [path обяз.]: string (uuid)

purchases:read

200: object

POST /api/v1/purchase-requests/{request_id}/submit

request_id [path обяз.]: string (uuid)

purchases:update

200: object

GET /api/v1/purchase-requests/{request_id}/revisions

request_id [path обяз.]: string (uuid)

purchases:read

200: object

POST /api/v1/purchase-requests/{request_id}/revisions

request_id [path обяз.]: string (uuid)

purchases:update

200: object

PATCH /api/v1/purchase-revisions/{revision_id}

revision_id [path обяз.]: string (uuid) | Тело: application/json: RevisionPatch

purchases:update

200: object

POST /api/v1/purchase-revisions/{revision_id}/submit

revision_id [path обяз.]: string (uuid)

purchases:update

200: object

POST /api/v1/purchase-revisions/{revision_id}/cancel

revision_id [path обяз.]: string (uuid)

purchases:update

200: object

GET /api/v1/purchase-approval-rules

Нет

approval_routes:read

200: object

POST /api/v1/purchase-approval-rules

Нет | Тело: application/json: RuleIn

approval_routes:create

200: object

PATCH /api/v1/purchase-approval-rules/{rule_id}

rule_id [path обяз.]: string (uuid) | Тело: application/json: RuleIn

approval_routes:update

200: object

DELETE /api/v1/purchase-approval-rules/{rule_id}

rule_id [path обяз.]: string (uuid)

approval_routes:delete

200: object

Справочник значений

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/reference/enums

Нет

Только сессия

200: object

Конструктор отчетов

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/report-builder/datasets

Нет

reports:read

200: object

GET /api/v1/report-builder/definitions

include_inactive [query]: boolean (default=false)

reports:read

200: object

POST /api/v1/report-builder/definitions

Нет | Тело: application/json: DefinitionPayload

report_builder:manage

201: object

GET /api/v1/report-builder/definitions/{key}

key [path обяз.]: string

reports:read

200: object

PUT /api/v1/report-builder/definitions/{key}

key [path обяз.]: string | Тело: application/json: DefinitionPayload

report_builder:manage

200: object

DELETE /api/v1/report-builder/definitions/{key}

key [path обяз.]: string

report_builder:manage

204

POST /api/v1/report-builder/definitions/{key}/run

key [path обяз.]: string | Тело: application/json: RunPayload

reports:read

200: object

POST /api/v1/report-builder/preview

Нет | Тело: application/json: PreviewPayload

report_builder:manage

200: object

Готовые отчеты

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/reports/portfolio-status

Нет

reports:read

200: PortfolioStatusReport

GET /api/v1/reports/evm

Нет

reports:read

200: object

GET /api/v1/reports/milestones

Нет

reports:read

200: object

GET /api/v1/reports/execution-discipline

Нет

reports:read

200: object

GET /api/v1/reports/approval-timing

Нет

reports:read

200: object

GET /api/v1/reports/overdue-docs

Нет

reports:read

200: object

GET /api/v1/reports/correspondence-register

start [query]: string (date) / null; end [query]: string (date) / null

reports:read

200: object

GET /api/v1/reports/document-volume

year [query обяз.]: integer

reports:read

200: object

GET /api/v1/reports/visible-keys

Нет

reports:read

200: object

GET /api/v1/reports/problem-projects

Нет

reports:read

200: ProblemProjectsReport

GET /api/v1/reports/overdue

Нет

reports:read

200: OverdueReport

GET /api/v1/reports/portfolio-tasks

project_id [query]: string (uuid) / null; state [query]: TaskState / null; responsible_id [query]: string (uuid) / null; planned_start_from [query]: string (date) / null; planned_start_to [query]: string (date) / null

reports:read

200: PortfolioTasksReport

GET /api/v1/reports/budget-analytics

Нет

reports:read

200: BudgetAnalyticsReport

GET /api/v1/reports/portfolio-status/pdf

Нет

reports:read

200: object

GET /api/v1/reports/problem-projects/pdf

Нет

reports:read

200: object

GET /api/v1/reports/overdue/pdf

Нет

reports:read

200: object

GET /api/v1/reports/portfolio-tasks/pdf

reports:read

200: object

GET /api/v1/reports/budget-analytics/pdf

Нет

reports:read

200: object

Поиск

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/search

q [query]: string (default=); limit [query]: integer / null

Только сессия

200: object

Пределы для интерфейса

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/tuning/client

Нет

Только сессия

200: object

Изображения редактора

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

POST /api/v1/uploads/editor-image

Нет | Тело: multipart/form-data: Body_upload_editor_image_api_v1_uploads_editor_image_post

Только сессия

200: object

GET /api/v1/uploads/editor-image/{filename}

filename [path обяз.]: string

Без авторизации

200: object

Настройки интерфейса пользователя

Метод и путь

Параметры и тело

Доступ (скоуп ключа)

Успешный ответ

GET /api/v1/users/me/preferences

Нет

Только сессия

200: UserPreferences

PUT /api/v1/users/me/preferences

Нет | Тело: application/json: UserPreferences

Только сессия

200: UserPreferences

Тела запросовПоля JSON и форм multipart из схемы сервера. «Да» - поле обязательно. Ссылка на другую схему (например, array[QCApproverInput]) означает вложенный объект с теми же полями.LayoutPayload: PUT /dashboard/me, PUT /dashboard/preset

Поле

Обязательно

Тип / значения

Ограничения

config

Да

object

RunWidgetPayload: POST /dashboard/run-widget

Поле

Обязательно

Тип / значения

Ограничения

dataset

Да

string

config

Нет

object / null

filters

Нет

object / null

TargetIn: POST /reports/deals/targets

Поле

Обязательно

Тип / значения

Ограничения

person_id

Да

string (uuid)

year

Да

integer

quarter

Нет

integer / null

amount

Да

number / string

StaleDays: PUT /reports/deals/settings/stale-days

Поле

Обязательно

Тип / значения

Ограничения

days

Да

integer

app__schemas__deal__ContactIn: POST /organizations/{org_id}/contacts

Поле

Обязательно

Тип / значения

Ограничения

full_name

Да

string

minLength=1; maxLength=255

position

Нет

string / null

phone

Нет

string / null

Нет

string / null

note

Нет

string / null

is_primary

Нет

boolean

default=false

DealCreate: POST /deals

Поле

Обязательно

Тип / значения

Ограничения

name

Да

string

minLength=1; maxLength=500

customer_id

Да

string (uuid)

facility

Нет

string / null

contact_id

Нет

string (uuid) / null

work_kinds

Нет

array[string]

default=[]

manager_id

Да

string (uuid)

probability

Нет

integer

default=10; minimum=0.0; maximum=100.0

planned_budget

Нет

number / string / null

planned_sign_date

Нет

string (date) / null

description

Нет

string / null

next_step

Нет

string / null

next_step_date

Нет

string (date) / null

qual_budget

Нет

boolean

default=false

qual_decision_maker

Нет

boolean

default=false

qual_criteria

Нет

boolean

default=false

qual_process

Нет

boolean

default=false

qual_champion_id

Нет

string (uuid) / null

qual_pain

Нет

string / null

tender_number

Нет

string / null

tender_law

Нет

string / null

tender_url

Нет

string / null

tender_platform

Нет

string / null

tender_nmck

Нет

number / string / null

tender_bid_deadline

Нет

string (date) / null

tender_result_date

Нет

string (date) / null

DealUpdate: PUT /deals/{deal_id}

Поле

Обязательно

Тип / значения

Ограничения

expected_updated_at

Нет

string (date-time) / null

name

Нет

string / null

customer_id

Нет

string (uuid) / null

facility

Нет

string / null

contact_id

Нет

string (uuid) / null

work_kinds

Нет

array[string] / null

manager_id

Нет

string (uuid) / null

probability

Нет

integer / null

planned_budget

Нет

number / string / null

planned_sign_date

Нет

string (date) / null

description

Нет

string / null

next_step

Нет

string / null

next_step_date

Нет

string (date) / null

qual_budget

Нет

boolean / null

qual_decision_maker

Нет

boolean / null

qual_criteria

Нет

boolean / null

qual_process

Нет

boolean / null

qual_champion_id

Нет

string (uuid) / null

qual_pain

Нет

string / null

tender_number

Нет

string / null

tender_law

Нет

string / null

tender_url

Нет

string / null

tender_platform

Нет

string / null

tender_nmck

Нет

number / string / null

tender_bid_deadline

Нет

string (date) / null

tender_result_date

Нет

string (date) / null

DealStatusChange: POST /deals/{deal_id}/status

Поле

Обязательно

Тип / значения

Ограничения

status

Да

string

loss_reason_id

Нет

string (uuid) / null

loss_comment

Нет

string / null

MeetingIn: POST /deals/{deal_id}/meeting

Поле

Обязательно

Тип / значения

Ограничения

starts_at

Да

string (date-time)

duration_minutes

Нет

integer

default=60; minimum=5.0; maximum=1440.0

title

Нет

string / null

location

Нет

string / null

description

Нет

string / null

attendees

Нет

array[string] / null

calendar_id

Нет

string (uuid) / null

reminder_minutes

Нет

integer / null

default=15

DealTransferIn: POST /deals/{deal_id}/transfer

Поле

Обязательно

Тип / значения

Ограничения

pm_id

Да

string (uuid)

eol_id

Нет

string (uuid) / null

admin_id

Нет

string (uuid) / null

start_date

Да

string (date)

end_date

Да

string (date)

document_set_id

Да

string (uuid)

carry_presale

Нет

boolean

default=true

ContactRoleIn: POST /deals/{deal_id}/contacts

Поле

Обязательно

Тип / значения

Ограничения

contact_id

Да

string (uuid)

role

Да

string

note

Нет

string / null

ContractLinkIn: POST /deals/{deal_id}/contracts

Поле

Обязательно

Тип / значения

Ограничения

contract_id

Да

string (uuid)

TeamMemberIn: POST /deals/{deal_id}/team, PUT /deals/{deal_id}/team/{member_id}

Поле

Обязательно

Тип / значения

Ограничения

employee_id

Да

string (uuid)

role_code

Нет

string / null

rate_card_id

Нет

string (uuid) / null

allocation_percent

Нет

number / string

default="100"

planned_hours

Нет

number / string / null

hourly_rate

Нет

number / string / null

BudgetLineIn: POST /deals/{deal_id}/budget/lines, PUT /deals/{deal_id}/budget/lines/{line_id}

Поле

Обязательно

Тип / значения

Ограничения