{ "info": { "name": "CREAM API", "description": "Укажите в переменных коллекции api_key и user_id. Описание API: раздел «Разработчикам» на сайте CREAM.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://crm.broker.kvadera.ru/api/v1" }, { "key": "api_key", "value": "" }, { "key": "user_id", "value": "" } ], "item": [ { "name": "Организация", "description": "Организация ключа: проверка, что ключ работает.", "item": [ { "name": "Организация ключа: проверка, что ключ работает.", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/organization/", "host": [ "{{baseUrl}}" ], "path": [ "organization", "" ], "query": [], "variable": [] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `name` | строка | да | Название |" } } ] }, { "name": "Словари", "description": "Все словари. only — какие нужны, через запятую; без него — все.", "item": [ { "name": "Все словари. only — какие нужны, через запятую; без него — все.", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/dictionaries/", "host": [ "{{baseUrl}}" ], "path": [ "dictionaries", "" ], "query": [ { "key": "only", "value": "", "description": "Названия словарей через запятую", "disabled": true } ], "variable": [] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `building_classes` | массив: объект | | Классы объектов |\n| `building_classes[].code` | строка | да | Код значения |\n| `building_classes[].name` | строка | да | Название |\n| `building_types` | массив: объект | | Типы объектов |\n| `building_types[].code` | строка | да | Код значения |\n| `building_types[].name` | строка | да | Название |\n| `space_purposes` | массив: объект | | Назначения блоков |\n| `space_purposes[].code` | строка | да | Код значения |\n| `space_purposes[].name` | строка | да | Название |\n| `ventilations` | массив: объект | | Виды вентиляции |\n| `ventilations[].code` | строка | да | Код значения |\n| `ventilations[].name` | строка | да | Название |\n| `conditionings` | массив: объект | | Виды кондиционирования |\n| `conditionings[].code` | строка | да | Код значения |\n| `conditionings[].name` | строка | да | Название |\n| `fire_systems` | массив: объект | | Пожарные системы |\n| `fire_systems[].code` | строка | да | Код значения |\n| `fire_systems[].name` | строка | да | Название |\n| `securities` | массив: объект | | Виды охраны |\n| `securities[].code` | строка | да | Код значения |\n| `securities[].name` | строка | да | Название |\n| `ground_parkings` | массив: объект | | Наземные парковки |\n| `ground_parkings[].code` | строка | да | Код значения |\n| `ground_parkings[].name` | строка | да | Название |\n| `covered_parkings` | массив: объект | | Крытые парковки |\n| `covered_parkings[].code` | строка | да | Код значения |\n| `covered_parkings[].name` | строка | да | Название |\n| `parking_ratios` | массив: объект | | Коэффициенты парковки |\n| `parking_ratios[].code` | строка | да | Код значения |\n| `parking_ratios[].name` | строка | да | Название |\n| `telecom_providers` | массив: объект | | Провайдеры связи |\n| `telecom_providers[].code` | строка | да | Код значения |\n| `telecom_providers[].name` | строка | да | Название |\n| `infrastructures` | массив: объект | | Инфраструктура |\n| `infrastructures[].code` | строка | да | Код значения |\n| `infrastructures[].name` | строка | да | Название |\n| `space_layouts` | массив: объект | | Планировки блоков |\n| `space_layouts[].code` | строка | да | Код значения |\n| `space_layouts[].name` | строка | да | Название |\n| `industries` | массив: объект | | Сферы деятельности контрагентов |\n| `industries[].code` | строка | да | Код значения |\n| `industries[].name` | строка | да | Название |\n| `readinesses` | массив: объект | | Готовность блока |\n| `readinesses[].code` | строка | да | Код значения |\n| `readinesses[].name` | строка | да | Название |\n| `readinesses[].with_date` | да / нет | да | У блока бывает дата «с». |\n| `contract_types` | массив: объект | | Типы договоров |\n| `contract_types[].code` | строка | да | Код значения |\n| `contract_types[].name` | строка | да | Название |\n| `contract_types[].deal_type` | строка | да | Тип сделки. Значения: rent, sale |\n| `vat_rate` | строка-число | | Ставка НДС, % |\n| `pipelines` | массив: объект | | Воронки и их стадии |\n| `pipelines[].id` | id | да | Id записи |\n| `pipelines[].kind` | строка | да | Вид сделок воронки. Значения: demand, supply |\n| `pipelines[].name` | строка | да | Название |\n| `pipelines[].sort` | число | | Порядок |\n| `pipelines[].is_default` | да / нет | | По умолчанию |\n| `pipelines[].stages` | массив: объект | да | Стадии воронки |\n| `lost_reasons` | массив: объект | | Причины проигрыша |\n| `lost_reasons[].id` | id | да | Id записи |\n| `lost_reasons[].name` | строка | да | Название |\n| `lost_reasons[].sort` | число | | Порядок |\n| `lost_reasons[].kind` | строка | | Вид сделок, к которым относится причина. Значения: demand, supply |\n| `lost_reasons[].is_other` | да / нет | да | «Другое» |\n| `sources` | массив: объект | | Источники |\n| `sources[].id` | id | да | Id записи |\n| `sources[].name` | строка | да | Название |\n| `sources[].sort` | число | | Порядок |\n| `special_offers` | массив: объект | | Спецпредложения |\n| `special_offers[].id` | id | да | Id записи |\n| `special_offers[].name` | строка | да | Название |\n| `special_offers[].slug` | строка | | Адрес |\n| `special_offers[].sort` | число | | Порядок |\n| `exchange_stages` | массив: объект | | Стадии биржи |\n| `exchange_stages[].id` | id | да | Id записи |\n| `exchange_stages[].name` | строка | да | Название |\n| `exchange_stages[].sort` | число | | Порядок |\n| `exchange_stages[].color` | строка | | Цвет |\n| `exchange_stages[].role` | строка | | Роль стадии в отчётах. Значения: sent, shown, negotiation, won, rejected |\n| `tags` | массив: объект | | Теги |\n| `tags[].id` | id | да | Id записи |\n| `tags[].entity` | строка | да | К каким записям относится тег. Значения: company, contact, building, space |\n| `tags[].name` | строка | да | Название |\n| `custom_fields` | массив: объект | | Свои поля |\n| `custom_fields[].id` | id | да | Id записи |\n| `custom_fields[].entity` | строка | да | К каким записям относится поле. Значения: company, contact, deal, building, space, offer |\n| `custom_fields[].key` | строка | да | Ключ |\n| `custom_fields[].name` | строка | да | Название |\n| `custom_fields[].type` | строка | да | Тип поля. Значения: string, number, date, select, multiselect, boolean, user |\n| `custom_fields[].options` | массив: строка | | Варианты |\n| `custom_fields[].required` | да / нет | | Обязательное |\n| `custom_fields[].section` | строка | | Раздел карточки |\n| `custom_fields[].sort` | число | да | Порядок |\n| `custom_fields[].client_visible` | да / нет | | Видно клиенту |\n| `custom_fields[].owner_visible` | да / нет | | Видно собственнику |\n| `departments` | массив: объект | | Отделы |\n| `departments[].id` | id | да | Id записи |\n| `departments[].name` | строка | да | Название |\n| `departments[].parent` | id | | Вышестоящий отдел: id |\n| `roles` | массив: объект | | Роли сотрудников |\n| `roles[].id` | id | да | Id записи |\n| `roles[].name` | строка | да | Название |\n| `roles[].system` | строка | да | Системная |\n| `call_lists` | массив: объект | | Списки обзвона |\n| `call_lists[].id` | id | да | Id записи |\n| `call_lists[].name` | строка | да | Название |\n| `call_outcomes` | массив: объект | | Результаты звонка |\n| `call_outcomes[].id` | id | да | Id записи |\n| `call_outcomes[].name` | строка | да | Название |\n| `call_outcomes[].sort` | число | | Порядок |\n| `call_outcomes[].action` | строка | да | Что делать с записью после звонка. Значения: callback, drop, move, owner, not_client, lead |\n| `call_outcomes[].days` | число | | Для «Перезвонить»: пусто — дату выбирает оператор. |\n| `call_outcomes[].target_list` | id | | Для «Перенести в другой список». |\n| `call_outcomes[].is_miss` | да / нет | | Считать в «недозвонов подряд». |\n| `cities` | массив: объект | | Города |\n| `cities[].id` | id | да | Id записи |\n| `cities[].name` | строка | да | Название |\n| `cities[].region` | строка | | Регион |\n| `districts` | массив: объект | | Округа и районы |\n| `districts[].id` | id | да | Id записи |\n| `districts[].city` | id | да | Город: id из словаря cities |\n| `districts[].parent` | id | | Округ, в который входит район: id |\n| `districts[].kind` | строка | да | Вид: okrug — округ, raion — район. Значения: okrug, raion |\n| `districts[].name` | строка | да | Название |\n| `metro_lines` | массив: объект | | Линии метро |\n| `metro_lines[].id` | id | да | Id записи |\n| `metro_lines[].city` | id | да | Город: id из словаря cities |\n| `metro_lines[].kind` | строка | | Вид линии: metro — метро, mcc — МЦК, mcd — МЦД. Значения: metro, mcc, mcd |\n| `metro_lines[].name` | строка | да | Название |\n| `metro_lines[].color` | строка | | Цвет |\n| `metro_stations` | массив: объект | | Станции метро |\n| `metro_stations[].id` | id | да | Id записи |\n| `metro_stations[].line` | id | да | Линия: id из словаря metro_lines |\n| `metro_stations[].name` | строка | да | Название |\n| `lead_statuses` | массив: объект | | Статусы лида |\n| `lead_statuses[].code` | строка | да | Код значения |\n| `lead_statuses[].name` | строка | да | Название |\n| `lead_channels` | массив: объект | | Каналы лида |\n| `lead_channels[].code` | строка | да | Код значения |\n| `lead_channels[].name` | строка | да | Название |\n| `deal_kinds` | массив: объект | | Виды сделок |\n| `deal_kinds[].code` | строка | да | Код значения |\n| `deal_kinds[].name` | строка | да | Название |\n| `requirement_deal_types` | массив: объект | | Типы сделки в заявке |\n| `requirement_deal_types[].code` | строка | да | Код значения |\n| `requirement_deal_types[].name` | строка | да | Название |\n| `budget_units` | массив: объект | | Единицы бюджета |\n| `budget_units[].code` | строка | да | Код значения |\n| `budget_units[].name` | строка | да | Название |\n| `offer_deal_types` | массив: объект | | Типы сделки условия |\n| `offer_deal_types[].code` | строка | да | Код значения |\n| `offer_deal_types[].name` | строка | да | Название |\n| `vat_modes` | массив: объект | | Режимы НДС |\n| `vat_modes[].code` | строка | да | Код значения |\n| `vat_modes[].name` | строка | да | Название |\n| `rent_rate_units` | массив: объект | | Единицы ставки аренды |\n| `rent_rate_units[].code` | строка | да | Код значения |\n| `rent_rate_units[].name` | строка | да | Название |\n| `sale_price_units` | массив: объект | | Единицы цены продажи |\n| `sale_price_units[].code` | строка | да | Код значения |\n| `sale_price_units[].name` | строка | да | Название |\n| `space_statuses` | массив: объект | | Статусы блока |\n| `space_statuses[].code` | строка | да | Код значения |\n| `space_statuses[].name` | строка | да | Название |\n| `verification_methods` | массив: объект | | Способы подтверждения актуальности |\n| `verification_methods[].code` | строка | да | Код значения |\n| `verification_methods[].name` | строка | да | Название |\n| `company_roles` | массив: объект | | Типы контрагентов |\n| `company_roles[].code` | строка | да | Код значения |\n| `company_roles[].name` | строка | да | Название |\n| `contact_method_kinds` | массив: объект | | Виды способов связи |\n| `contact_method_kinds[].code` | строка | да | Код значения |\n| `contact_method_kinds[].name` | строка | да | Название |\n| `task_repeats` | массив: объект | | Повторы задач |\n| `task_repeats[].code` | строка | да | Код значения |\n| `task_repeats[].name` | строка | да | Название |\n| `custom_field_types` | массив: объект | | Типы своих полей |\n| `custom_field_types[].code` | строка | да | Код значения |\n| `custom_field_types[].name` | строка | да | Название |\n| `positions` | массив: объект | | Особые должности |\n| `positions[].code` | строка | да | Код значения |\n| `positions[].name` | строка | да | Название |" } } ] }, { "name": "События", "description": "Лента изменений: created, updated, deleted. Хранится 30 дней. Сохраните next и", "item": [ { "name": "Лента изменений: created, updated, deleted. Хранится 30 дней. Сохраните next и", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/events/", "host": [ "{{baseUrl}}" ], "path": [ "events", "" ], "query": [ { "key": "action", "value": "", "description": "created, updated, deleted через запятую", "disabled": true }, { "key": "after", "value": "", "description": "Курсор из next; latest — только новые, без истории; без него — с самого начала", "disabled": true }, { "key": "entity", "value": "", "description": "Сущности через запятую", "disabled": true }, { "key": "limit", "value": "", "description": "Сколько событий, до 500; по умолчанию 100", "disabled": true } ], "variable": [] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `events` | массив: объект | да | События |\n| `events[].cursor` | строка | да | Положение события в ленте |\n| `events[].entity` | строка | да | Вид записи. Значения: lead, deal, building, space, user, company, contact, selection, task |\n| `events[].action` | строка | да | Что произошло: создание, изменение или удаление. Значения: created, updated, deleted |\n| `events[].id` | id | да | Id записи |\n| `events[].changed` | массив: строка | да | Изменённые поля (только у updated) |\n| `events[].occurred_at` | дата и время | да | Когда произошло |\n| `events[].source` | объект | да | Кто внёс изменение |\n| `next` | строка | да | Курсор для следующего запроса |" } } ] }, { "name": "Лиды", "description": "Лиды: входящие обращения до разбора.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/leads/", "host": [ "{{baseUrl}}" ], "path": [ "leads", "" ], "query": [ { "key": "channel", "value": "", "description": "Канал лида: словарь lead_channels. Значения: api, call, calling, form, import, manual, messenger", "disabled": true }, { "key": "created_by", "value": "", "description": "Кто создал: id сотрудника", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "form", "value": "", "description": "Форма сайта: id", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "processed_by", "value": "", "description": "Кто разобрал: id сотрудника", "disabled": true }, { "key": "search", "value": "", "description": "Поиск по тексту", "disabled": true }, { "key": "source", "value": "", "description": "Источник: id из словаря sources", "disabled": true }, { "key": "status", "value": "", "description": "Статус: значения через запятую", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/leads/", "host": [ "{{baseUrl}}" ], "path": [ "leads", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `source` | id | | Источник: id из словаря sources |\n| `name` | строка | | Имя |\n| `phone` | строка | | Телефон |\n| `email` | почта | | Почта |\n| `company_name` | строка | | Контрагент |\n| `text` | строка | | Текст обращения |\n| `requirement` | объект | | Заявка лида — базовые поля заявки сделки (deals.Requirement), всё необязательно. Хранится в Lead.requirement как в API: коды, числа строками. |\n| `requirement.deal_type` | строка | | Тип сделки. Значения: rent, sale |\n| `requirement.purposes` | массив: строка | | Назначения: коды из словаря space_purposes |\n| `requirement.building_classes` | массив: строка | | Классы объекта: коды из словаря building_classes |\n| `requirement.area_from` | строка-число | | Площадь от, м² |\n| `requirement.area_to` | строка-число | | Площадь до, м² |\n| `requirement.budget_from_rub` | строка-число | | Бюджет от, ₽ |\n| `requirement.budget_to_rub` | строка-число | | Бюджет до, ₽ |\n| `requirement.budget_unit` | строка | | Единица бюджета: словарь budget_units. Значения: sqm_year, month_total, sqm, total |\n| `requirement.max_metro_minutes` | число | | До метро не больше, минут |\n| `requirement.workplaces` | число | | Рабочих мест |\n| `requirement.move_in_date` | дата | | Дата въезда |\n| `space` | id | | Блок: id |\n| `company` | id | | Контрагент: id |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/leads/:id/", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `number` | число | да | Номер |\n| `status` | строка | да | Статус. Значения: new, converted, rejected |\n| `channel` | строка | да | Канал лида. Значения: manual, form, call, messenger, calling, import, api |\n| `source` | id | | Источник: id из словаря sources |\n| `source_name` | строка | да | Название источника |\n| `name` | строка | да | Имя |\n| `phone` | строка | да | Телефон |\n| `email` | почта | да | Почта |\n| `company_name` | строка | да | Контрагент |\n| `text` | строка | да | Текст обращения |\n| `requirement` | объект | | Заявка лида — базовые поля заявки сделки (deals.Requirement), всё необязательно. Хранится в Lead.requirement как в API: коды, числа строками. |\n| `requirement.deal_type` | строка | | Тип сделки. Значения: rent, sale |\n| `requirement.purposes` | массив: строка | | Назначения: коды из словаря space_purposes |\n| `requirement.building_classes` | массив: строка | | Классы объекта: коды из словаря building_classes |\n| `requirement.area_from` | строка-число | | Площадь от, м² |\n| `requirement.area_to` | строка-число | | Площадь до, м² |\n| `requirement.budget_from_rub` | строка-число | | Бюджет от, ₽ |\n| `requirement.budget_to_rub` | строка-число | | Бюджет до, ₽ |\n| `requirement.budget_unit` | строка | | Единица бюджета: словарь budget_units. Значения: sqm_year, month_total, sqm, total |\n| `requirement.max_metro_minutes` | число | | До метро не больше, минут |\n| `requirement.workplaces` | число | | Рабочих мест |\n| `requirement.move_in_date` | дата | | Дата въезда |\n| `space` | id | | Блок: id |\n| `space_info` | объект | да | Блок: краткие данные |\n| `space_info.id` | id | да | Id записи |\n| `space_info.number` | число | да | Номер блока |\n| `space_info.area` | строка-число | да | Площадь, м² |\n| `space_info.floor` | число | да | Этаж: −1 — подвал, 0 — цоколь |\n| `space_info.attic` | да / нет | да | Мансарда |\n| `space_info.floor_label` | строка | да | Подпись этажа |\n| `space_info.building` | строка | да | Название или адрес объекта |\n| `form` | id | да | Форма |\n| `form_name` | строка | да | Название формы сайта |\n| `call` | id | да | Звонок |\n| `chat` | id | да | Чат |\n| `contact` | id | да | Контакт: id |\n| `contact_name` | строка | да | Имя контакта |\n| `company` | id | | Контрагент: id |\n| `company_title` | строка | да | Название контрагента |\n| `deal` | id | да | Сделка: id |\n| `deal_title` | строка | да | Название сделки |\n| `reject_reason` | строка | да | Причина отказа |\n| `processed_at` | дата и время | да | Разобран |\n| `processed_by` | id | да | Кто разобрал: id сотрудника |\n| `created_by` | id | да | Кто создал: id сотрудника |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/leads/:id/", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `source` | id | | Источник: id из словаря sources |\n| `name` | строка | | Имя |\n| `phone` | строка | | Телефон |\n| `email` | почта | | Почта |\n| `company_name` | строка | | Контрагент |\n| `text` | строка | | Текст обращения |\n| `requirement` | объект | | Заявка лида — базовые поля заявки сделки (deals.Requirement), всё необязательно. Хранится в Lead.requirement как в API: коды, числа строками. |\n| `requirement.deal_type` | строка | | Тип сделки. Значения: rent, sale |\n| `requirement.purposes` | массив: строка | | Назначения: коды из словаря space_purposes |\n| `requirement.building_classes` | массив: строка | | Классы объекта: коды из словаря building_classes |\n| `requirement.area_from` | строка-число | | Площадь от, м² |\n| `requirement.area_to` | строка-число | | Площадь до, м² |\n| `requirement.budget_from_rub` | строка-число | | Бюджет от, ₽ |\n| `requirement.budget_to_rub` | строка-число | | Бюджет до, ₽ |\n| `requirement.budget_unit` | строка | | Единица бюджета: словарь budget_units. Значения: sqm_year, month_total, sqm, total |\n| `requirement.max_metro_minutes` | число | | До метро не больше, минут |\n| `requirement.workplaces` | число | | Рабочих мест |\n| `requirement.move_in_date` | дата | | Дата въезда |\n| `space` | id | | Блок: id |\n| `company` | id | | Контрагент: id |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Разобрать лид: контакт, контрагент и сделка — найденные или новые.", "request": { "method": "POST", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/leads/:id/convert/", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":id", "convert", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `contact` | id | | Найденный контакт |\n| `create_contact` | да / нет | | Новый контакт из обращения |\n| `company` | id | | Найденный контрагент |\n| `create_company` | да / нет | | Новый контрагент из обращения |\n| `deal` | id | | Существующая сделка |\n| `pipeline` | id | | Новая сделка в этой воронке |\n| `deal_title` | строка | | Название сделки |\n| `responsible` | id | | Ответственный новых контрагента и сделки; пусто — кто разбирает. В пределах разбора лидов роли (на себя / на отдел / на всех) |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Отказать по лиду.", "request": { "method": "POST", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/leads/:id/reject/", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":id", "reject", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `reason` | строка | да | Причина отказа |", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Сделки", "description": "Сделки с заявкой, контактами и блоками.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/deals/", "host": [ "{{baseUrl}}" ], "path": [ "deals", "" ], "query": [ { "key": "company", "value": "", "description": "Контрагент: id", "disabled": true }, { "key": "contact", "value": "", "description": "Контакт: id", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "custom", "value": "", "description": "Свои поля: JSON «ключ поля → условие»", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "is_open", "value": "", "description": "true — открытые, false — закрытые", "disabled": true }, { "key": "kind", "value": "", "description": "Вид сделки: demand — от клиента, supply — от объекта. Значения: demand, supply", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "pipeline", "value": "", "description": "Воронка: id из словаря pipelines", "disabled": true }, { "key": "responsible", "value": "", "description": "Ответственный: id сотрудника; для объектов и none — без ответственного", "disabled": true }, { "key": "search", "value": "", "description": "Поиск по тексту", "disabled": true }, { "key": "source", "value": "", "description": "Источник: id из словаря sources", "disabled": true }, { "key": "stage", "value": "", "description": "Стадия: id", "disabled": true }, { "key": "stages", "value": "", "description": "Стадии: id через запятую", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/", "host": [ "{{baseUrl}}" ], "path": [ "deals", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `pipeline` | id | да | Воронка: id из словаря pipelines |\n| `stage` | id | | Стадия: id из словаря pipelines |\n| `title` | строка | да | Название |\n| `company` | id | да | Контрагент: id |\n| `contacts` | массив: объект | | Контакты |\n| `contacts[].contact` | id | да | Контакт: id |\n| `contacts[].is_primary` | да / нет | | Основной |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `source` | id | | Источник: id из словаря sources |\n| `expected_commission_rub` | строка-число | | Ожидаемая комиссия, ₽ |\n| `close_date` | дата | | Плановая дата закрытия |\n| `lost_reason` | id | | Причина проигрыша — обязательна при переводе на стадию провала |\n| `lost_comment` | строка | | Комментарий к причине проигрыша |\n| `requirement` | объект | | Заявка клиента |\n| `requirement.area_polygon` | объект | | GeoJSON Polygon или MultiPolygon |\n| `requirement.deal_type` | строка | да | Тип сделки. Значения: rent, sale |\n| `requirement.is_gab` | да / нет | | Покупка готового арендного бизнеса. |\n| `requirement.area_from` | строка-число | | Площадь от, м² |\n| `requirement.area_to` | строка-число | | Площадь до, м² |\n| `requirement.budget_from_rub` | строка-число | | Бюджет от, ₽ |\n| `requirement.budget_to_rub` | строка-число | | Бюджет до, ₽ |\n| `requirement.budget_unit` | строка | | Единица бюджета: словарь budget_units. Значения: sqm_year, month_total, sqm, total |\n| `requirement.max_metro_minutes` | число | | До метро не дальше, мин |\n| `requirement.floor_from` | число | | Этаж от |\n| `requirement.floor_to` | число | | Этаж до |\n| `requirement.parking_places` | число | | Машиномест |\n| `requirement.readiness` | массив: строка | | Состояние |\n| `requirement.move_in_date` | дата | | Дата въезда |\n| `requirement.lease_term_months` | число | | Срок аренды, мес. |\n| `requirement.workplaces` | число | | Рабочих мест |\n| `requirement.search_started` | строка | | Когда начали искать |\n| `requirement.already_seen` | строка | | Что уже смотрели |\n| `requirement.comment` | строка | | Комментарий |\n| `requirement.purposes` | массив: строка | | Назначения |\n| `requirement.building_classes` | массив: строка | | Классы |\n| `requirement.cities` | массив: id | | Города: id из словаря cities |\n| `requirement.districts` | массив: id | | Округа и районы: id из словаря districts |\n| `requirement.metro_stations` | массив: id | | Станции метро: id из словаря metro_stations |\n| `spaces` | массив: id | | Блоки |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{\n \"pipeline\": \"\",\n \"title\": \"\",\n \"company\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/deals/:id/", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `number` | число | да | Номер |\n| `kind` | строка | да | Вид сделки: demand — от клиента, supply — от объекта |\n| `pipeline` | id | да | Воронка: id из словаря pipelines |\n| `stage` | id | | Стадия: id из словаря pipelines |\n| `title` | строка | да | Название |\n| `company` | id | да | Контрагент: id |\n| `company_name` | строка | да | Название контрагента |\n| `contacts` | массив: объект | да | Контакты |\n| `contacts[].contact` | id | да | Контакт: id |\n| `contacts[].full_name` | строка | да | ФИО |\n| `contacts[].is_primary` | да / нет | | Основной |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `source` | id | | Источник: id из словаря sources |\n| `source_name` | строка | да | Название источника |\n| `expected_commission_rub` | строка-число | да | Ожидаемая комиссия, ₽ |\n| `close_date` | дата | да | Плановая дата закрытия |\n| `lost_reason` | id | | Причина проигрыша — обязательна при переводе на стадию провала |\n| `lost_reason_name` | строка | да | Название причины проигрыша |\n| `lost_comment` | строка | да | Комментарий к причине проигрыша |\n| `stage_changed_at` | дата и время | да | Стадия изменена |\n| `closed_at` | дата и время | да | Закрыта |\n| `requirement` | объект | да | Заявка клиента |\n| `requirement.area_polygon` | объект | | GeoJSON Polygon или MultiPolygon |\n| `requirement.deal_type` | строка | да | Тип сделки. Значения: rent, sale |\n| `requirement.is_gab` | да / нет | | Покупка готового арендного бизнеса. |\n| `requirement.area_from` | строка-число | | Площадь от, м² |\n| `requirement.area_to` | строка-число | | Площадь до, м² |\n| `requirement.budget_from_rub` | строка-число | | Бюджет от, ₽ |\n| `requirement.budget_to_rub` | строка-число | | Бюджет до, ₽ |\n| `requirement.budget_unit` | строка | | Единица бюджета: словарь budget_units. Значения: sqm_year, month_total, sqm, total |\n| `requirement.max_metro_minutes` | число | | До метро не дальше, мин |\n| `requirement.floor_from` | число | | Этаж от |\n| `requirement.floor_to` | число | | Этаж до |\n| `requirement.parking_places` | число | | Машиномест |\n| `requirement.readiness` | массив: строка | | Состояние |\n| `requirement.move_in_date` | дата | | Дата въезда |\n| `requirement.lease_term_months` | число | | Срок аренды, мес. |\n| `requirement.workplaces` | число | | Рабочих мест |\n| `requirement.search_started` | строка | | Когда начали искать |\n| `requirement.already_seen` | строка | | Что уже смотрели |\n| `requirement.comment` | строка | | Комментарий |\n| `requirement.purposes` | массив: строка | | Назначения |\n| `requirement.building_classes` | массив: строка | | Классы |\n| `requirement.cities` | массив: id | | Города: id из словаря cities |\n| `requirement.districts` | массив: id | | Округа и районы: id из словаря districts |\n| `requirement.metro_stations` | массив: id | | Станции метро: id из словаря metro_stations |\n| `spaces` | массив: объект | да | Блоки |\n| `spaces[].id` | id | да | Id записи |\n| `spaces[].number` | число | да | Номер |\n| `spaces[].building` | id | да | Объект: id |\n| `spaces[].building_name` | строка | да | Название объекта |\n| `spaces[].address` | строка | да | Адрес объекта |\n| `spaces[].floor` | число | | −1 — подвал, 0 — цоколь |\n| `spaces[].area` | строка-число | да | Площадь, м² |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `last_activity_at` | дата и время | да | Когда было последнее событие ленты сделки (аннотация DealViewSet). |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `pipeline` | id | | Воронка: id из словаря pipelines |\n| `stage` | id | | Стадия: id из словаря pipelines |\n| `title` | строка | | Название |\n| `company` | id | | Контрагент: id |\n| `contacts` | массив: объект | | Контакты |\n| `contacts[].contact` | id | да | Контакт: id |\n| `contacts[].is_primary` | да / нет | | Основной |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `source` | id | | Источник: id из словаря sources |\n| `expected_commission_rub` | строка-число | | Ожидаемая комиссия, ₽ |\n| `close_date` | дата | | Плановая дата закрытия |\n| `lost_reason` | id | | Причина проигрыша — обязательна при переводе на стадию провала |\n| `lost_comment` | строка | | Комментарий к причине проигрыша |\n| `requirement` | объект | | Заявка клиента |\n| `requirement.area_polygon` | объект | | GeoJSON Polygon или MultiPolygon |\n| `requirement.deal_type` | строка | да | Тип сделки. Значения: rent, sale |\n| `requirement.is_gab` | да / нет | | Покупка готового арендного бизнеса. |\n| `requirement.area_from` | строка-число | | Площадь от, м² |\n| `requirement.area_to` | строка-число | | Площадь до, м² |\n| `requirement.budget_from_rub` | строка-число | | Бюджет от, ₽ |\n| `requirement.budget_to_rub` | строка-число | | Бюджет до, ₽ |\n| `requirement.budget_unit` | строка | | Единица бюджета: словарь budget_units. Значения: sqm_year, month_total, sqm, total |\n| `requirement.max_metro_minutes` | число | | До метро не дальше, мин |\n| `requirement.floor_from` | число | | Этаж от |\n| `requirement.floor_to` | число | | Этаж до |\n| `requirement.parking_places` | число | | Машиномест |\n| `requirement.readiness` | массив: строка | | Состояние |\n| `requirement.move_in_date` | дата | | Дата въезда |\n| `requirement.lease_term_months` | число | | Срок аренды, мес. |\n| `requirement.workplaces` | число | | Рабочих мест |\n| `requirement.search_started` | строка | | Когда начали искать |\n| `requirement.already_seen` | строка | | Что уже смотрели |\n| `requirement.comment` | строка | | Комментарий |\n| `requirement.purposes` | массив: строка | | Назначения |\n| `requirement.building_classes` | массив: строка | | Классы |\n| `requirement.cities` | массив: id | | Города: id из словаря cities |\n| `requirement.districts` | массив: id | | Округа и районы: id из словаря districts |\n| `requirement.metro_stations` | массив: id | | Станции метро: id из словаря metro_stations |\n| `spaces` | массив: id | | Блоки |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Перевести сделку на стадию; на стадию провала — с причиной.", "request": { "method": "POST", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/deals/:id/move/", "host": [ "{{baseUrl}}" ], "path": [ "deals", ":id", "move", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `stage` | id | да | Стадия: id из словаря pipelines |\n| `lost_reason` | id | | Причина проигрыша — обязательна при переводе на стадию провала |\n| `lost_comment` | строка | | Комментарий к причине проигрыша |", "body": { "mode": "raw", "raw": "{\n \"stage\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Объекты", "description": "Объекты со всеми блоками и условиями.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buildings/", "host": [ "{{baseUrl}}" ], "path": [ "buildings", "" ], "query": [ { "key": "assistant", "value": "", "description": "Ассистент: id сотрудника или none", "disabled": true }, { "key": "building_class", "value": "", "description": "Класс объекта: код из словаря building_classes", "disabled": true }, { "key": "building_type", "value": "", "description": "Тип объекта: код из словаря building_types", "disabled": true }, { "key": "city", "value": "", "description": "Город: id из словаря cities", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "custom", "value": "", "description": "Свои поля: JSON «ключ поля → условие»", "disabled": true }, { "key": "district", "value": "", "description": "Округ или район: id из словаря districts", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "responsible", "value": "", "description": "Ответственный: id сотрудника; для объектов и none — без ответственного", "disabled": true }, { "key": "search", "value": "", "description": "Поиск по тексту", "disabled": true }, { "key": "tag", "value": "", "description": "Тег", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/buildings/", "host": [ "{{baseUrl}}" ], "path": [ "buildings", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `address` | строка | да | Адрес |\n| `city` | id | | Город: id из словаря cities |\n| `district` | id | | Округ или район: id из словаря districts |\n| `point` | объект | | Точка на карте |\n| `point.lat` | число | да | Широта |\n| `point.lon` | число | да | Долгота |\n| `name` | строка | | Название |\n| `name_en` | строка | | Название на английском |\n| `building_type` | строка | | Тип |\n| `building_class` | строка | | Класс |\n| `floors` | число | | Этажность |\n| `year_built` | число | | Год постройки |\n| `year_reconstructed` | число | | Год реконструкции |\n| `building_area` | строка-число | | Площадь объекта, м² |\n| `land_area` | строка-число | | Площадь участка, м² |\n| `lifts_passenger` | число | | Лифтов пассажирских |\n| `lifts_cargo` | число | | Лифтов грузовых |\n| `ventilation` | строка | | Вентиляция |\n| `conditioning` | строка | | Кондиционирование |\n| `fire_system` | строка | | Пожарная система |\n| `security` | строка | | Охрана |\n| `telecom_providers` | массив: строка | | Провайдеры связи: коды из словаря telecom_providers |\n| `parking_coeff` | строка | | Парковочный коэффициент |\n| `parking_ground` | строка | | Парковка наземная |\n| `parking_covered` | строка | | Парковка крытая |\n| `parking_ground_price_rub` | строка-число | | Наземное место, ₽ в месяц |\n| `parking_covered_price_rub` | строка-число | | Крытое место, ₽ в месяц |\n| `infrastructure` | массив: строка | | Инфраструктура: коды из словаря infrastructures |\n| `management_company` | строка | | Управляющая компания |\n| `tax_office` | строка | | Налоговая инспекция |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `assistant` | id | | Ассистент: id сотрудника |\n| `owner` | id | | Собственник: id контрагента |\n| `notes` | строка | | Заметки |\n| `tags` | массив: строка | | Теги |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{\n \"address\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buildings/:id/", "host": [ "{{baseUrl}}" ], "path": [ "buildings", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `number` | число | да | Номер |\n| `address` | строка | да | Адрес |\n| `city` | id | да | Город: id из словаря cities |\n| `district` | id | да | Округ или район: id из словаря districts |\n| `point` | объект | | Точка на карте |\n| `point.lat` | число | да | Широта |\n| `point.lon` | число | да | Долгота |\n| `name` | строка | да | Название |\n| `name_en` | строка | да | Название на английском |\n| `building_type` | строка | да | Тип |\n| `building_class` | строка | да | Класс |\n| `floors` | число | да | Этажность |\n| `year_built` | число | да | Год постройки |\n| `year_reconstructed` | число | да | Год реконструкции |\n| `building_area` | строка-число | да | Площадь объекта, м² |\n| `land_area` | строка-число | да | Площадь участка, м² |\n| `lifts_passenger` | число | да | Лифтов пассажирских |\n| `lifts_cargo` | число | да | Лифтов грузовых |\n| `ventilation` | строка | да | Вентиляция |\n| `conditioning` | строка | да | Кондиционирование |\n| `fire_system` | строка | да | Пожарная система |\n| `security` | строка | да | Охрана |\n| `telecom_providers` | массив: строка | | Провайдеры связи: коды из словаря telecom_providers |\n| `parking_coeff` | строка | да | Парковочный коэффициент |\n| `parking_ground` | строка | да | Парковка наземная |\n| `parking_covered` | строка | да | Парковка крытая |\n| `parking_ground_price_rub` | строка-число | да | Наземное место, ₽ в месяц |\n| `parking_covered_price_rub` | строка-число | да | Крытое место, ₽ в месяц |\n| `infrastructure` | массив: строка | | Инфраструктура: коды из словаря infrastructures |\n| `management_company` | строка | да | Управляющая компания |\n| `tax_office` | строка | да | Налоговая инспекция |\n| `metro` | массив: объект | да | Станции метро рядом |\n| `metro[].station` | id | да | Станция: id из словаря metro_stations |\n| `metro[].station_name` | строка | да | Название станции |\n| `metro[].line` | строка | да | Линия метро |\n| `metro[].line_color` | строка | да | Цвет линии |\n| `metro[].distance_m` | число | да | Расстояние, м |\n| `metro[].minutes` | число | да | Минут |\n| `metro[].mode` | строка | да | Как добраться: walk — пешком, transport — транспортом. Значения: walk, transport |\n| `metro[].is_manual` | да / нет | | Исправлено вручную |\n| `photo` | строка | да | Адрес первого снимка: превью |\n| `cover` | строка | да | Адрес первого снимка: для шапки карточки |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `assistant` | id | | Ассистент: id сотрудника |\n| `owner` | id | | Собственник: id контрагента |\n| `owner_name` | строка | да | Название собственника |\n| `notes` | строка | да | Заметки |\n| `tags` | массив: строка | да | Теги |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `spaces` | массив: объект | да | Блоки |\n| `spaces[].id` | id | да | Id записи |\n| `spaces[].number` | число | да | Номер |\n| `spaces[].building` | id | да | Объект: id |\n| `spaces[].floor` | число | да | −1 — подвал, 0 — цоколь |\n| `spaces[].attic` | да / нет | да | этаж — при желании тоже |\n| `spaces[].floor_label` | строка | да | «1–2 этажи» |\n| `spaces[].whole_building` | да / нет | да | Объект целиком |\n| `spaces[].separate_entrance` | да / нет | да | Отдельный вход |\n| `spaces[].area` | строка-число | да | Площадь, м² |\n| `spaces[].area_min` | строка-число | да | Мин. площадь при делении, м² |\n| `spaces[].area_max` | строка-число | да | Макс. площадь при объединении, м² |\n| `spaces[].area_usable` | строка-число | да | Полезная площадь, м² |\n| `spaces[].corridor_coeff` | строка-число | да | Коридорный коэффициент, % |\n| `spaces[].purpose` | строка | да | Назначение |\n| `spaces[].layout` | строка | да | Планировка |\n| `spaces[].ceiling_height` | строка-число | да | Высота потолков, м |\n| `spaces[].power_kw` | строка-число | да | Мощность, кВт |\n| `spaces[].workplaces` | число | да | Рабочих мест |\n| `spaces[].parking_places` | число | да | Машиномест |\n| `spaces[].readiness` | строка | да | Состояние |\n| `spaces[].ready_date` | дата | да | «Готово к въезду с» / «Под отделку с» — только у состояний с датой (Readiness.with_date). |\n| `spaces[].status` | строка | да | Статус. Значения: free, off_market |\n| `spaces[].verified_at` | дата и время | да | Подтверждён |\n| `spaces[].verified_by` | id | да | Кто подтвердил актуальность: id сотрудника |\n| `spaces[].verification_method` | строка | да | Способ подтверждения актуальности. Значения: broker_call, owner, sync |\n| `spaces[].owner` | id | | Собственник: id контрагента |\n| `spaces[].owner_name` | строка | да | Название собственника |\n| `spaces[].external_id` | строка | да | Код блока |\n| `spaces[].video_url` | адрес | да | Видео |\n| `spaces[].tags` | массив: строка | да | Теги |\n| `spaces[].custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `spaces[].photo` | строка | да | Адрес первого снимка: превью |\n| `spaces[].plan` | строка | да | Первая планировка (как в CREAM при наведении). |\n| `spaces[].on_site` | да / нет | да | Показывать на сайте |\n| `spaces[].always_on_site` | да / нет | да | Всегда на сайте |\n| `spaces[].special_offers` | массив: id | | Глобальные: на сайтах, где не заданы свои. |\n| `spaces[].offers` | массив: объект | да | Условия |\n| `spaces[].created_at` | дата и время | да | Когда создано |\n| `spaces[].updated_at` | дата и время | да | Когда изменено |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/buildings/:id/", "host": [ "{{baseUrl}}" ], "path": [ "buildings", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `address` | строка | | Адрес |\n| `city` | id | | Город: id из словаря cities |\n| `district` | id | | Округ или район: id из словаря districts |\n| `point` | объект | | Точка на карте |\n| `point.lat` | число | да | Широта |\n| `point.lon` | число | да | Долгота |\n| `name` | строка | | Название |\n| `name_en` | строка | | Название на английском |\n| `building_type` | строка | | Тип |\n| `building_class` | строка | | Класс |\n| `floors` | число | | Этажность |\n| `year_built` | число | | Год постройки |\n| `year_reconstructed` | число | | Год реконструкции |\n| `building_area` | строка-число | | Площадь объекта, м² |\n| `land_area` | строка-число | | Площадь участка, м² |\n| `lifts_passenger` | число | | Лифтов пассажирских |\n| `lifts_cargo` | число | | Лифтов грузовых |\n| `ventilation` | строка | | Вентиляция |\n| `conditioning` | строка | | Кондиционирование |\n| `fire_system` | строка | | Пожарная система |\n| `security` | строка | | Охрана |\n| `telecom_providers` | массив: строка | | Провайдеры связи: коды из словаря telecom_providers |\n| `parking_coeff` | строка | | Парковочный коэффициент |\n| `parking_ground` | строка | | Парковка наземная |\n| `parking_covered` | строка | | Парковка крытая |\n| `parking_ground_price_rub` | строка-число | | Наземное место, ₽ в месяц |\n| `parking_covered_price_rub` | строка-число | | Крытое место, ₽ в месяц |\n| `infrastructure` | массив: строка | | Инфраструктура: коды из словаря infrastructures |\n| `management_company` | строка | | Управляющая компания |\n| `tax_office` | строка | | Налоговая инспекция |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `assistant` | id | | Ассистент: id сотрудника |\n| `owner` | id | | Собственник: id контрагента |\n| `notes` | строка | | Заметки |\n| `tags` | массив: строка | | Теги |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Блоки", "description": "Блоки с условиями.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/spaces/", "host": [ "{{baseUrl}}" ], "path": [ "spaces", "" ], "query": [ { "key": "agent_commission", "value": "", "description": "Есть комиссия агенту-партнёру", "disabled": true }, { "key": "always_advertised", "value": "", "description": "Условие всегда в рекламе", "disabled": true }, { "key": "area_from", "value": "", "description": "Площадь от, м²", "disabled": true }, { "key": "area_to", "value": "", "description": "Площадь до, м²", "disabled": true }, { "key": "assistant", "value": "", "description": "Ассистент: id сотрудника или none", "disabled": true }, { "key": "building", "value": "", "description": "Объект: id", "disabled": true }, { "key": "building_class", "value": "", "description": "Класс объекта: код из словаря building_classes", "disabled": true }, { "key": "building_type", "value": "", "description": "Тип объекта: код из словаря building_types", "disabled": true }, { "key": "city", "value": "", "description": "Город: id из словаря cities", "disabled": true }, { "key": "client_commission", "value": "", "description": "Есть комиссия с клиента", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "custom", "value": "", "description": "Свои поля: JSON «ключ поля → условие»", "disabled": true }, { "key": "deal_type", "value": "", "description": "Тип сделки условия: rent — аренда, sale — продажа. Значения: rent, sale", "disabled": true }, { "key": "district", "value": "", "description": "Округ или район: id из словаря districts", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "feed", "value": "", "description": "Есть в фиде", "disabled": true }, { "key": "floor_from", "value": "", "description": "Этаж от", "disabled": true }, { "key": "floor_to", "value": "", "description": "Этаж до", "disabled": true }, { "key": "gab", "value": "", "description": "Готовый арендный бизнес", "disabled": true }, { "key": "gab_yield_min", "value": "", "description": "ГАБ: доходность не ниже, % годовых", "disabled": true }, { "key": "has_photo", "value": "", "description": "Есть фото", "disabled": true }, { "key": "has_plans", "value": "", "description": "Есть планировки", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "is_active", "value": "", "description": "Условие активно", "disabled": true }, { "key": "layout", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "metro", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "metro_minutes", "value": "", "description": "До метро не дальше, мин", "disabled": true }, { "key": "on_site", "value": "", "description": "Блок на сайте", "disabled": true }, { "key": "owner", "value": "", "description": "Собственник блока (пусто у блока — объекта)", "disabled": true }, { "key": "owner_commission", "value": "", "description": "Есть комиссия от собственника", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "price_from", "value": "", "description": "Цена продажи от, ₽", "disabled": true }, { "key": "price_to", "value": "", "description": "Цена продажи до, ₽", "disabled": true }, { "key": "price_unit", "value": "", "description": "Единица цены (по умолчанию ₽ за м² в год, при продаже — ₽ за м²). Значения: month_total, sqm, sqm_year, total", "disabled": true }, { "key": "purpose", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "q", "value": "", "description": "Название, адрес или номер объекта / блока", "disabled": true }, { "key": "readiness", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "responsible", "value": "", "description": "Ответственный: id сотрудника; для объектов и none — без ответственного", "disabled": true }, { "key": "special", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "status", "value": "", "description": "Статус: значения через запятую", "disabled": true }, { "key": "tags", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true }, { "key": "verified_before", "value": "", "description": "Актуальность подтверждена раньше этого момента", "disabled": true }, { "key": "verified_from", "value": "", "description": "Актуальность подтверждена с этой даты", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/spaces/", "host": [ "{{baseUrl}}" ], "path": [ "spaces", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `building` | id | да | Объект: id |\n| `floor` | число | | −1 — подвал, 0 — цоколь |\n| `attic` | да / нет | | этаж — при желании тоже |\n| `floor_label` | строка | | «1–2 этажи» |\n| `whole_building` | да / нет | | Объект целиком |\n| `separate_entrance` | да / нет | | Отдельный вход |\n| `area` | строка-число | да | Площадь, м² |\n| `area_min` | строка-число | | Мин. площадь при делении, м² |\n| `area_max` | строка-число | | Макс. площадь при объединении, м² |\n| `area_usable` | строка-число | | Полезная площадь, м² |\n| `corridor_coeff` | строка-число | | Коридорный коэффициент, % |\n| `purpose` | строка | да | Назначение |\n| `layout` | строка | | Планировка |\n| `ceiling_height` | строка-число | | Высота потолков, м |\n| `power_kw` | строка-число | | Мощность, кВт |\n| `workplaces` | число | | Рабочих мест |\n| `parking_places` | число | | Машиномест |\n| `readiness` | строка | | Состояние |\n| `ready_date` | дата | | «Готово к въезду с» / «Под отделку с» — только у состояний с датой (Readiness.with_date). |\n| `status` | строка | | Статус. Значения: free, off_market |\n| `owner` | id | | Собственник: id контрагента |\n| `external_id` | строка | | Код блока |\n| `video_url` | адрес | | Видео |\n| `tags` | массив: строка | | Теги |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `on_site` | да / нет | | Показывать на сайте |\n| `always_on_site` | да / нет | | Всегда на сайте |\n| `special_offers` | массив: id | | Глобальные: на сайтах, где не заданы свои. |", "body": { "mode": "raw", "raw": "{\n \"building\": \"\",\n \"area\": \"\",\n \"purpose\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/spaces/:id/", "host": [ "{{baseUrl}}" ], "path": [ "spaces", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `number` | число | да | Номер |\n| `building` | id | да | Объект: id |\n| `floor` | число | да | −1 — подвал, 0 — цоколь |\n| `attic` | да / нет | да | этаж — при желании тоже |\n| `floor_label` | строка | да | «1–2 этажи» |\n| `whole_building` | да / нет | да | Объект целиком |\n| `separate_entrance` | да / нет | да | Отдельный вход |\n| `area` | строка-число | да | Площадь, м² |\n| `area_min` | строка-число | да | Мин. площадь при делении, м² |\n| `area_max` | строка-число | да | Макс. площадь при объединении, м² |\n| `area_usable` | строка-число | да | Полезная площадь, м² |\n| `corridor_coeff` | строка-число | да | Коридорный коэффициент, % |\n| `purpose` | строка | да | Назначение |\n| `layout` | строка | да | Планировка |\n| `ceiling_height` | строка-число | да | Высота потолков, м |\n| `power_kw` | строка-число | да | Мощность, кВт |\n| `workplaces` | число | да | Рабочих мест |\n| `parking_places` | число | да | Машиномест |\n| `readiness` | строка | да | Состояние |\n| `ready_date` | дата | да | «Готово к въезду с» / «Под отделку с» — только у состояний с датой (Readiness.with_date). |\n| `status` | строка | да | Статус. Значения: free, off_market |\n| `verified_at` | дата и время | да | Подтверждён |\n| `verified_by` | id | да | Кто подтвердил актуальность: id сотрудника |\n| `verification_method` | строка | да | Способ подтверждения актуальности. Значения: broker_call, owner, sync |\n| `owner` | id | | Собственник: id контрагента |\n| `owner_name` | строка | да | Название собственника |\n| `external_id` | строка | да | Код блока |\n| `video_url` | адрес | да | Видео |\n| `tags` | массив: строка | да | Теги |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `photo` | строка | да | Адрес первого снимка: превью |\n| `plan` | строка | да | Первая планировка (как в CREAM при наведении). |\n| `on_site` | да / нет | да | Показывать на сайте |\n| `always_on_site` | да / нет | да | Всегда на сайте |\n| `special_offers` | массив: id | | Глобальные: на сайтах, где не заданы свои. |\n| `offers` | массив: объект | да | Условия |\n| `offers[].id` | id | да | Id записи |\n| `offers[].space` | id | да | Блок: id |\n| `offers[].deal_type` | строка | да | Тип сделки. Значения: rent, sale |\n| `offers[].is_active` | да / нет | да | Активно |\n| `offers[].vat_mode` | строка | да | Режим НДС. Значения: included, on_top, none, usn, usn_5, usn_7 |\n| `offers[].contract_type` | строка | да | Тип договора |\n| `offers[].rent_rate_input` | строка-число | | Ставка в единице rent_rate_input_unit. Хранится в ₽ за м² в год. |\n| `offers[].rent_rate_input_unit` | строка | да | Единица ставки аренды: словарь rent_rate_units. Значения: sqm_year, month_total |\n| `offers[].rent_rate_rub_sqm_year` | строка-число | да | Ставка, ₽ за м² в год |\n| `offers[].opex_included` | да / нет | да | Эксплуатация включена |\n| `offers[].opex_rub_sqm_year` | строка-число | да | Эксплуатация, ₽ за м² в год |\n| `offers[].utilities_included` | да / нет | да | Коммунальные включены |\n| `offers[].deposit_months` | строка-число | да | Депозит, мес. |\n| `offers[].advance_months` | строка-число | да | Аванс, мес. |\n| `offers[].lease_term_months` | число | да | Срок договора, мес. |\n| `offers[].indexation_pct` | строка-число | да | Индексация, % в год |\n| `offers[].sale_price_input` | строка-число | | Цена в единице sale_price_input_unit. Хранится за помещение (sale_price_rub). |\n| `offers[].sale_price_input_unit` | строка | да | Единица цены продажи: словарь sale_price_units. Значения: total, sqm |\n| `offers[].sale_price_rub` | строка-число | да | Цена, ₽ |\n| `offers[].is_gab` | да / нет | да | Готовый арендный бизнес |\n| `offers[].gab_tenants` | строка | да | Арендаторы (ГАБ) |\n| `offers[].gab_income_rub_year` | строка-число | да | Годовая арендная плата (ГАП), ₽ |\n| `offers[].gab_indexation_pct` | строка-число | да | Индексация арендной платы (ГАБ), % в год |\n| `offers[].commission_owner_pct` | строка-число | да | Комиссия от собственника, % |\n| `offers[].commission_client_pct` | строка-число | да | Комиссия с клиента, % |\n| `offers[].commission_agent_share_pct` | строка-число | да | Совместная работа: какую часть своей комиссии агентство отдаёт агенту, который привёл клиента (ЦИАН — AgentFee). |\n| `offers[].ad_title` | строка | да | Заголовок объявления |\n| `offers[].ad_description` | строка | да | Текст объявления |\n| `offers[].ad_title_template` | id | да | Шаблон заголовка |\n| `offers[].ad_description_template` | id | да | Шаблон описания |\n| `offers[].always_advertised` | да / нет | да | Всегда в рекламе |\n| `offers[].custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `offers[].prices` | объект | да | Расчётные цены: аренда — rate_sqm_year, rate_sqm_month, month_total, year_total; продажа — total, per_sqm; ГАБ — ещё income_year, income_month, payback_years, yield_pct (строки, без НДС). |\n| `offers[].created_at` | дата и время | да | Когда создано |\n| `offers[].updated_at` | дата и время | да | Когда изменено |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/spaces/:id/", "host": [ "{{baseUrl}}" ], "path": [ "spaces", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `building` | id | | Объект: id |\n| `floor` | число | | −1 — подвал, 0 — цоколь |\n| `attic` | да / нет | | этаж — при желании тоже |\n| `floor_label` | строка | | «1–2 этажи» |\n| `whole_building` | да / нет | | Объект целиком |\n| `separate_entrance` | да / нет | | Отдельный вход |\n| `area` | строка-число | | Площадь, м² |\n| `area_min` | строка-число | | Мин. площадь при делении, м² |\n| `area_max` | строка-число | | Макс. площадь при объединении, м² |\n| `area_usable` | строка-число | | Полезная площадь, м² |\n| `corridor_coeff` | строка-число | | Коридорный коэффициент, % |\n| `purpose` | строка | | Назначение |\n| `layout` | строка | | Планировка |\n| `ceiling_height` | строка-число | | Высота потолков, м |\n| `power_kw` | строка-число | | Мощность, кВт |\n| `workplaces` | число | | Рабочих мест |\n| `parking_places` | число | | Машиномест |\n| `readiness` | строка | | Состояние |\n| `ready_date` | дата | | «Готово к въезду с» / «Под отделку с» — только у состояний с датой (Readiness.with_date). |\n| `status` | строка | | Статус. Значения: free, off_market |\n| `owner` | id | | Собственник: id контрагента |\n| `external_id` | строка | | Код блока |\n| `video_url` | адрес | | Видео |\n| `tags` | массив: строка | | Теги |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `on_site` | да / нет | | Показывать на сайте |\n| `always_on_site` | да / нет | | Всегда на сайте |\n| `special_offers` | массив: id | | Глобальные: на сайтах, где не заданы свои. |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Условия", "description": "Условия блока: аренда и продажа.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/offers/", "host": [ "{{baseUrl}}" ], "path": [ "offers", "" ], "query": [ { "key": "building", "value": "", "description": "Объект: id", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "deal_type", "value": "", "description": "Тип сделки условия: rent — аренда, sale — продажа. Значения: rent, sale", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "is_active", "value": "", "description": "Условие активно", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "price_from", "value": "", "description": "Цена продажи от, ₽", "disabled": true }, { "key": "price_to", "value": "", "description": "Цена продажи до, ₽", "disabled": true }, { "key": "rate_from", "value": "", "description": "Ставка от, ₽ за м² в год", "disabled": true }, { "key": "rate_to", "value": "", "description": "Ставка до, ₽ за м² в год", "disabled": true }, { "key": "space", "value": "", "description": "Блок: id", "disabled": true }, { "key": "space_number", "value": "", "description": "Номер блока", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true }, { "key": "vat_mode", "value": "", "description": "Режим НДС: словарь vat_modes. Значения: included, none, on_top, usn, usn_5, usn_7", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/offers/", "host": [ "{{baseUrl}}" ], "path": [ "offers", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `space` | id | да | Блок: id |\n| `deal_type` | строка | да | Тип сделки. Значения: rent, sale |\n| `is_active` | да / нет | | Активно |\n| `vat_mode` | строка | | Режим НДС. Значения: included, on_top, none, usn, usn_5, usn_7 |\n| `contract_type` | строка | | Тип договора |\n| `rent_rate_input` | строка-число | | Ставка в единице rent_rate_input_unit. Хранится в ₽ за м² в год. |\n| `rent_rate_input_unit` | строка | | Единица ставки аренды: словарь rent_rate_units. Значения: sqm_year, month_total |\n| `opex_included` | да / нет | | Эксплуатация включена |\n| `opex_rub_sqm_year` | строка-число | | Эксплуатация, ₽ за м² в год |\n| `utilities_included` | да / нет | | Коммунальные включены |\n| `deposit_months` | строка-число | | Депозит, мес. |\n| `advance_months` | строка-число | | Аванс, мес. |\n| `lease_term_months` | число | | Срок договора, мес. |\n| `indexation_pct` | строка-число | | Индексация, % в год |\n| `sale_price_input` | строка-число | | Цена в единице sale_price_input_unit. Хранится за помещение (sale_price_rub). |\n| `sale_price_input_unit` | строка | | Единица цены продажи: словарь sale_price_units. Значения: total, sqm |\n| `sale_price_rub` | строка-число | | Цена, ₽ |\n| `is_gab` | да / нет | | Готовый арендный бизнес |\n| `gab_tenants` | строка | | Арендаторы (ГАБ) |\n| `gab_income_rub_year` | строка-число | | Годовая арендная плата (ГАП), ₽ |\n| `gab_indexation_pct` | строка-число | | Индексация арендной платы (ГАБ), % в год |\n| `commission_owner_pct` | строка-число | | Комиссия от собственника, % |\n| `commission_client_pct` | строка-число | | Комиссия с клиента, % |\n| `commission_agent_share_pct` | строка-число | | Совместная работа: какую часть своей комиссии агентство отдаёт агенту, который привёл клиента (ЦИАН — AgentFee). |\n| `ad_title` | строка | | Заголовок объявления |\n| `ad_description` | строка | | Текст объявления |\n| `ad_title_template` | id | | Шаблон заголовка |\n| `ad_description_template` | id | | Шаблон описания |\n| `always_advertised` | да / нет | | Всегда в рекламе |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{\n \"space\": \"\",\n \"deal_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/offers/:id/", "host": [ "{{baseUrl}}" ], "path": [ "offers", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `space` | id | да | Блок: id |\n| `deal_type` | строка | да | Тип сделки. Значения: rent, sale |\n| `is_active` | да / нет | да | Активно |\n| `vat_mode` | строка | да | Режим НДС. Значения: included, on_top, none, usn, usn_5, usn_7 |\n| `contract_type` | строка | да | Тип договора |\n| `rent_rate_input` | строка-число | | Ставка в единице rent_rate_input_unit. Хранится в ₽ за м² в год. |\n| `rent_rate_input_unit` | строка | да | Единица ставки аренды: словарь rent_rate_units. Значения: sqm_year, month_total |\n| `rent_rate_rub_sqm_year` | строка-число | да | Ставка, ₽ за м² в год |\n| `opex_included` | да / нет | да | Эксплуатация включена |\n| `opex_rub_sqm_year` | строка-число | да | Эксплуатация, ₽ за м² в год |\n| `utilities_included` | да / нет | да | Коммунальные включены |\n| `deposit_months` | строка-число | да | Депозит, мес. |\n| `advance_months` | строка-число | да | Аванс, мес. |\n| `lease_term_months` | число | да | Срок договора, мес. |\n| `indexation_pct` | строка-число | да | Индексация, % в год |\n| `sale_price_input` | строка-число | | Цена в единице sale_price_input_unit. Хранится за помещение (sale_price_rub). |\n| `sale_price_input_unit` | строка | да | Единица цены продажи: словарь sale_price_units. Значения: total, sqm |\n| `sale_price_rub` | строка-число | да | Цена, ₽ |\n| `is_gab` | да / нет | да | Готовый арендный бизнес |\n| `gab_tenants` | строка | да | Арендаторы (ГАБ) |\n| `gab_income_rub_year` | строка-число | да | Годовая арендная плата (ГАП), ₽ |\n| `gab_indexation_pct` | строка-число | да | Индексация арендной платы (ГАБ), % в год |\n| `commission_owner_pct` | строка-число | да | Комиссия от собственника, % |\n| `commission_client_pct` | строка-число | да | Комиссия с клиента, % |\n| `commission_agent_share_pct` | строка-число | да | Совместная работа: какую часть своей комиссии агентство отдаёт агенту, который привёл клиента (ЦИАН — AgentFee). |\n| `ad_title` | строка | да | Заголовок объявления |\n| `ad_description` | строка | да | Текст объявления |\n| `ad_title_template` | id | да | Шаблон заголовка |\n| `ad_description_template` | id | да | Шаблон описания |\n| `always_advertised` | да / нет | да | Всегда в рекламе |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `prices` | объект | да | Расчётные цены: аренда — rate_sqm_year, rate_sqm_month, month_total, year_total; продажа — total, per_sqm; ГАБ — ещё income_year, income_month, payback_years, yield_pct (строки, без НДС). |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/offers/:id/", "host": [ "{{baseUrl}}" ], "path": [ "offers", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `space` | id | | Блок: id |\n| `deal_type` | строка | | Тип сделки. Значения: rent, sale |\n| `is_active` | да / нет | | Активно |\n| `vat_mode` | строка | | Режим НДС. Значения: included, on_top, none, usn, usn_5, usn_7 |\n| `contract_type` | строка | | Тип договора |\n| `rent_rate_input` | строка-число | | Ставка в единице rent_rate_input_unit. Хранится в ₽ за м² в год. |\n| `rent_rate_input_unit` | строка | | Единица ставки аренды: словарь rent_rate_units. Значения: sqm_year, month_total |\n| `opex_included` | да / нет | | Эксплуатация включена |\n| `opex_rub_sqm_year` | строка-число | | Эксплуатация, ₽ за м² в год |\n| `utilities_included` | да / нет | | Коммунальные включены |\n| `deposit_months` | строка-число | | Депозит, мес. |\n| `advance_months` | строка-число | | Аванс, мес. |\n| `lease_term_months` | число | | Срок договора, мес. |\n| `indexation_pct` | строка-число | | Индексация, % в год |\n| `sale_price_input` | строка-число | | Цена в единице sale_price_input_unit. Хранится за помещение (sale_price_rub). |\n| `sale_price_input_unit` | строка | | Единица цены продажи: словарь sale_price_units. Значения: total, sqm |\n| `sale_price_rub` | строка-число | | Цена, ₽ |\n| `is_gab` | да / нет | | Готовый арендный бизнес |\n| `gab_tenants` | строка | | Арендаторы (ГАБ) |\n| `gab_income_rub_year` | строка-число | | Годовая арендная плата (ГАП), ₽ |\n| `gab_indexation_pct` | строка-число | | Индексация арендной платы (ГАБ), % в год |\n| `commission_owner_pct` | строка-число | | Комиссия от собственника, % |\n| `commission_client_pct` | строка-число | | Комиссия с клиента, % |\n| `commission_agent_share_pct` | строка-число | | Совместная работа: какую часть своей комиссии агентство отдаёт агенту, который привёл клиента (ЦИАН — AgentFee). |\n| `ad_title` | строка | | Заголовок объявления |\n| `ad_description` | строка | | Текст объявления |\n| `ad_title_template` | id | | Шаблон заголовка |\n| `ad_description_template` | id | | Шаблон описания |\n| `always_advertised` | да / нет | | Всегда в рекламе |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Пользователи", "description": "Сотрудники компании; id — значение X-User-Id при записи.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/", "host": [ "{{baseUrl}}" ], "path": [ "users", "" ], "query": [ { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "department", "value": "", "description": "Отдел: id из словаря departments", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "position", "value": "", "description": "Особая должность: словарь positions. Значения: actualization, ads, calling", "disabled": true }, { "key": "role", "value": "", "description": "Для контрагентов — тип: client, owner, agent; для сотрудников — id роли", "disabled": true }, { "key": "search", "value": "", "description": "Поиск по тексту", "disabled": true }, { "key": "status", "value": "", "description": "Статус: значения через запятую. Значения: active, disabled, invited", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true } ], "variable": [] } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/:id/", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `email` | почта | да | Почта |\n| `phone` | строка | да | Телефон |\n| `last_name` | строка | да | Фамилия |\n| `first_name` | строка | да | Имя |\n| `middle_name` | строка | да | Отчество |\n| `status` | строка | да | Статус. Значения: invited, active, disabled |\n| `is_owner` | да / нет | да | Владелец организации |\n| `role` | объект | да | Роль |\n| `role.id` | id | да | Id записи |\n| `role.name` | строка | да | Название |\n| `role.system` | строка | да | Код системной роли; пусто — своя роль |\n| `department` | объект | да | Отдел |\n| `department.id` | id | да | Id записи |\n| `department.name` | строка | да | Название |\n| `positions` | массив: строка | да | Особые должности: коды из словаря positions |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } } ] }, { "name": "Контрагенты", "description": "Контрагенты со всеми контактами.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/", "host": [ "{{baseUrl}}" ], "path": [ "companies", "" ], "query": [ { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "custom", "value": "", "description": "Свои поля: JSON «ключ поля → условие»", "disabled": true }, { "key": "due", "value": "", "description": "В обзвоне: пора звонить", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "industry", "value": "", "description": "Сфера деятельности: код из словаря industries", "disabled": true }, { "key": "inn", "value": "", "description": "ИНН", "disabled": true }, { "key": "list", "value": "", "description": "Список: working — кого нет в обзвоне, calling — все в обзвоне, иначе id списка", "disabled": true }, { "key": "outcome", "value": "", "description": "В обзвоне: итог последнего звонка", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "responsible", "value": "", "description": "Ответственный: id сотрудника; для объектов и none — без ответственного", "disabled": true }, { "key": "role", "value": "", "description": "Для контрагентов — тип: client, owner, agent; для сотрудников — id роли. Значения: agent, client, owner", "disabled": true }, { "key": "search", "value": "", "description": "Поиск по тексту", "disabled": true }, { "key": "tag", "value": "", "description": "Тег", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/", "host": [ "{{baseUrl}}" ], "path": [ "companies", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `name` | строка | да | Название |\n| `name_en` | строка | | Название на английском |\n| `roles` | массив: строка | | Типы контрагента: client — клиент, owner — собственник, agent — агент |\n| `inn` | строка | | ИНН |\n| `kpp` | строка | | КПП |\n| `ogrn` | строка | | ОГРН |\n| `okpo` | строка | | ОКПО |\n| `okved` | строка | | ОКВЭД |\n| `legal_address` | строка | | Юридический адрес |\n| `actual_address` | строка | | Фактический адрес |\n| `industry` | строка | | Сфера деятельности |\n| `employees` | число | | Сотрудников |\n| `website` | адрес | | Сайт |\n| `affiliation` | строка | | Аффилированность |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `tags` | массив: строка | | Теги |\n| `comment` | строка | | Комментарий |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/companies/:id/", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `name` | строка | да | Название |\n| `name_en` | строка | да | Название на английском |\n| `roles` | массив: строка | | Типы контрагента: client — клиент, owner — собственник, agent — агент |\n| `inn` | строка | да | ИНН |\n| `kpp` | строка | да | КПП |\n| `ogrn` | строка | да | ОГРН |\n| `okpo` | строка | да | ОКПО |\n| `okved` | строка | да | ОКВЭД |\n| `legal_address` | строка | да | Юридический адрес |\n| `actual_address` | строка | да | Фактический адрес |\n| `industry` | строка | да | Сфера деятельности |\n| `employees` | число | да | Сотрудников |\n| `website` | адрес | да | Сайт |\n| `affiliation` | строка | да | Аффилированность |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `tags` | массив: строка | да | Теги |\n| `comment` | строка | да | Комментарий |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `contacts` | массив: объект | да | Контакты |\n| `contacts[].contact` | объект | да | Способы связи и компании передаются списками и заменяются целиком. |\n| `contacts[].position` | строка | | Должность |\n| `contacts[].is_primary` | да / нет | | Основной контрагент |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:id/", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `name` | строка | | Название |\n| `name_en` | строка | | Название на английском |\n| `roles` | массив: строка | | Типы контрагента: client — клиент, owner — собственник, agent — агент |\n| `inn` | строка | | ИНН |\n| `kpp` | строка | | КПП |\n| `ogrn` | строка | | ОГРН |\n| `okpo` | строка | | ОКПО |\n| `okved` | строка | | ОКВЭД |\n| `legal_address` | строка | | Юридический адрес |\n| `actual_address` | строка | | Фактический адрес |\n| `industry` | строка | | Сфера деятельности |\n| `employees` | число | | Сотрудников |\n| `website` | адрес | | Сайт |\n| `affiliation` | строка | | Аффилированность |\n| `responsible` | id | | Ответственный: id сотрудника |\n| `tags` | массив: строка | | Теги |\n| `comment` | строка | | Комментарий |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Контакты", "description": "Контакты и их контрагенты.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/contacts/", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "" ], "query": [ { "key": "company", "value": "", "description": "Контрагент: id", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "custom", "value": "", "description": "Свои поля: JSON «ключ поля → условие»", "disabled": true }, { "key": "email", "value": "", "description": "Почта", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "phone", "value": "", "description": "Телефон в любом формате", "disabled": true }, { "key": "search", "value": "", "description": "Поиск по тексту", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts/", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `last_name` | строка | | Фамилия |\n| `first_name` | строка | | Имя |\n| `middle_name` | строка | | Отчество |\n| `methods` | массив: объект | | Способы связи |\n| `methods[].kind` | строка | да | Вид способа связи. Значения: phone, email, telegram, whatsapp, max |\n| `methods[].value` | строка | да | Значение |\n| `methods[].is_primary` | да / нет | | Основной |\n| `methods[].comment` | строка | | Комментарий |\n| `companies` | массив: объект | | Контрагенты контакта |\n| `companies[].company` | id | да | Контрагент: id |\n| `companies[].position` | строка | | Должность |\n| `companies[].is_primary` | да / нет | | Основной контрагент |\n| `tags` | массив: строка | | Теги |\n| `comment` | строка | | Комментарий |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/contacts/:id/", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `full_name` | строка | да | ФИО |\n| `last_name` | строка | да | Фамилия |\n| `first_name` | строка | да | Имя |\n| `middle_name` | строка | да | Отчество |\n| `methods` | массив: объект | | Способы связи |\n| `methods[].kind` | строка | да | Вид способа связи. Значения: phone, email, telegram, whatsapp, max |\n| `methods[].value` | строка | да | Значение |\n| `methods[].is_primary` | да / нет | | Основной |\n| `methods[].comment` | строка | | Комментарий |\n| `companies` | массив: объект | да | Контрагенты контакта |\n| `companies[].company` | id | да | Контрагент: id |\n| `companies[].company_name` | строка | да | Название контрагента |\n| `companies[].position` | строка | | Должность |\n| `companies[].is_primary` | да / нет | | Основной контрагент |\n| `tags` | массив: строка | да | Теги |\n| `comment` | строка | да | Комментарий |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts/:id/", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `last_name` | строка | | Фамилия |\n| `first_name` | строка | | Имя |\n| `middle_name` | строка | | Отчество |\n| `methods` | массив: объект | | Способы связи |\n| `methods[].kind` | строка | да | Вид способа связи. Значения: phone, email, telegram, whatsapp, max |\n| `methods[].value` | строка | да | Значение |\n| `methods[].is_primary` | да / нет | | Основной |\n| `methods[].comment` | строка | | Комментарий |\n| `companies` | массив: объект | | Контрагенты контакта |\n| `companies[].company` | id | да | Контрагент: id |\n| `companies[].position` | строка | | Должность |\n| `companies[].is_primary` | да / нет | | Основной контрагент |\n| `tags` | массив: строка | | Теги |\n| `comment` | строка | | Комментарий |\n| `custom` | объект | | Настраиваемые поля: ключ поля → значение. В запросе — только изменения; null убирает значение. |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Подборки", "description": "Подборки: блоки, реакции клиента, ссылки.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/selections/", "host": [ "{{baseUrl}}" ], "path": [ "selections", "" ], "query": [ { "key": "created_by", "value": "", "description": "Кто создал: id сотрудника", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "deal", "value": "", "description": "Сделка: id", "disabled": true }, { "key": "has_deal", "value": "", "description": "Подборка привязана к сделке", "disabled": true }, { "key": "has_link", "value": "", "description": "Есть ссылка для клиента", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "search", "value": "", "description": "Поиск по тексту", "disabled": true }, { "key": "space", "value": "", "description": "Блок: id", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true } ], "variable": [] } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/selections/:id/", "host": [ "{{baseUrl}}" ], "path": [ "selections", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `title` | строка | да | Название |\n| `deal` | id | да | Если указана — отправка и реакции клиента попадают на биржу сделки. |\n| `comment` | строка | да | Комментарий для клиента |\n| `created_by` | id | да | Кто создал: id сотрудника |\n| `template` | id | да | Вид страницы для клиента; пусто — основной шаблон организации. |\n| `items` | массив: объект | да | Условия в подборке |\n| `items[].offer` | id | да | Условие: id |\n| `items[].space` | id | да | Блок: id |\n| `items[].building` | id | да | Объект: id |\n| `items[].deal_type` | строка | да | Тип сделки: rent — аренда, sale — продажа |\n| `items[].comment` | строка | да | Комментарий брокера |\n| `items[].client_reaction` | строка | да | Реакция клиента: interested — интересно, not_suitable — не подходит, пусто — нет реакции |\n| `items[].reaction_reason` | строка | да | Причина реакции клиента |\n| `links` | массив: объект | да | Ссылки для клиента |\n| `links[].token` | строка | да | Токен ссылки: страница подборки — /s/{token} |\n| `links[].expires_at` | дата и время | | Действует до |\n| `links[].revoked_at` | дата и время | | Отозвана |\n| `links[].created_at` | дата и время | да | Когда создано |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } } ] }, { "name": "Задачи", "description": "Задачи с чек-листом.", "item": [ { "name": "Список", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/", "host": [ "{{baseUrl}}" ], "path": [ "tasks", "" ], "query": [ { "key": "assignee", "value": "", "description": "Исполнитель: id сотрудника", "disabled": true }, { "key": "author", "value": "", "description": "Кто поставил: id сотрудника", "disabled": true }, { "key": "building", "value": "", "description": "Объект: id", "disabled": true }, { "key": "co_assignee", "value": "", "description": "Соисполнитель: id сотрудника", "disabled": true }, { "key": "company", "value": "", "description": "Контрагент: id", "disabled": true }, { "key": "contact", "value": "", "description": "Контакт: id", "disabled": true }, { "key": "created_from", "value": "", "description": "Создано с этого момента", "disabled": true }, { "key": "created_to", "value": "", "description": "Создано до этого момента", "disabled": true }, { "key": "cursor", "value": "", "description": "Страница: значение из next или previous прошлого ответа", "disabled": true }, { "key": "deal", "value": "", "description": "Сделка: id", "disabled": true }, { "key": "due_before", "value": "", "description": "Срок раньше этого момента", "disabled": true }, { "key": "external_ref", "value": "", "description": "Id записи в вашей системе (X-External-Ref)", "disabled": true }, { "key": "ids", "value": "", "description": "Несколько значений могут быть разделены запятыми.", "disabled": true }, { "key": "is_done", "value": "", "description": "true — выполненные, false — открытые", "disabled": true }, { "key": "overdue", "value": "", "description": "Срок прошёл", "disabled": true }, { "key": "page_size", "value": "", "description": "Записей на странице: по умолчанию 100, у объектов 20; до 500, у объектов до 100", "disabled": true }, { "key": "space", "value": "", "description": "Блок: id", "disabled": true }, { "key": "updated_from", "value": "", "description": "Изменено с этого момента", "disabled": true }, { "key": "updated_to", "value": "", "description": "Изменено до этого момента", "disabled": true }, { "key": "watcher", "value": "", "description": "Наблюдатель: id сотрудника", "disabled": true } ], "variable": [] } } }, { "name": "Создать", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "", "description": "Повтор запроса с тем же ключом вернёт первый ответ, новой записи не будет", "disabled": true }, { "key": "X-External-Ref", "value": "", "description": "Id записи в вашей системе: если такая уже есть — запрос обновит её", "disabled": true }, { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tasks/", "host": [ "{{baseUrl}}" ], "path": [ "tasks", "" ], "query": [], "variable": [] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `title` | строка | да | Задача |\n| `description` | строка | | Подробности |\n| `assignee` | id | | Исполнитель: id сотрудника |\n| `co_assignees` | массив: id | | Соисполнители: id сотрудников |\n| `watchers` | массив: id | | Наблюдатели: id сотрудников |\n| `due_at` | дата и время | | Срок |\n| `remind_at` | дата и время | | Напомнить |\n| `repeat` | строка | | Повтор задачи. Значения: daily, workdays, weekly, monthly |\n| `repeat_until` | дата | | Повторять до |\n| `deal` | id | | Сделка: id |\n| `company` | id | | Контрагент: id |\n| `contact` | id | | Контакт: id |\n| `building` | id | | Объект: id |\n| `space` | id | | Блок: id |", "body": { "mode": "raw", "raw": "{\n \"title\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Одна запись", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id/", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Ответ\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `id` | id | да | Id записи |\n| `title` | строка | да | Задача |\n| `description` | строка | да | Подробности |\n| `assignee` | id | | Исполнитель: id сотрудника |\n| `co_assignees` | массив: id | | Соисполнители: id сотрудников |\n| `watchers` | массив: id | | Наблюдатели: id сотрудников |\n| `due_at` | дата и время | да | Срок |\n| `remind_at` | дата и время | да | Напомнить |\n| `repeat` | строка | да | Повтор задачи. Значения: daily, workdays, weekly, monthly |\n| `repeat_until` | дата | да | Повторять до |\n| `done_at` | дата и время | да | Выполнена |\n| `is_overdue` | да / нет | да | Задача просрочена |\n| `author` | id | да | Поставил |\n| `deal` | id | | Сделка: id |\n| `company` | id | | Контрагент: id |\n| `contact` | id | | Контакт: id |\n| `building` | id | | Объект: id |\n| `space` | id | | Блок: id |\n| `checklist` | массив: объект | да | Чек-лист |\n| `checklist[].id` | id | да | Id записи |\n| `checklist[].task` | id | да | Задача: id |\n| `checklist[].text` | строка | да | Пункт |\n| `checklist[].is_done` | да / нет | | Сделано |\n| `checklist[].position` | число | | Порядок |\n| `comments_count` | число | да | Комментариев |\n| `created_at` | дата и время | да | Когда создано |\n| `updated_at` | дата и время | да | Когда изменено |" } }, { "name": "Изменить", "request": { "method": "PATCH", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tasks/:id/", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] }, "description": "### Тело запроса\n\n| Поле | Тип | Обязательное | Описание |\n| --- | --- | --- | --- |\n| `title` | строка | | Задача |\n| `description` | строка | | Подробности |\n| `assignee` | id | | Исполнитель: id сотрудника |\n| `co_assignees` | массив: id | | Соисполнители: id сотрудников |\n| `watchers` | массив: id | | Наблюдатели: id сотрудников |\n| `due_at` | дата и время | | Срок |\n| `remind_at` | дата и время | | Напомнить |\n| `repeat` | строка | | Повтор задачи. Значения: daily, workdays, weekly, monthly |\n| `repeat_until` | дата | | Повторять до |\n| `deal` | id | | Сделка: id |\n| `company` | id | | Контрагент: id |\n| `contact` | id | | Контакт: id |\n| `building` | id | | Объект: id |\n| `space` | id | | Блок: id |", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Задача выполнена.", "request": { "method": "POST", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false } ], "url": { "raw": "{{baseUrl}}/tasks/:id/complete/", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "complete", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Вернуть задачу в работу.", "request": { "method": "POST", "header": [ { "key": "X-User-Id", "value": "{{user_id}}", "description": "Сотрудник, от имени которого запись: id из GET /users/", "disabled": false } ], "url": { "raw": "{{baseUrl}}/tasks/:id/reopen/", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "reopen", "" ], "query": [], "variable": [ { "key": "id", "value": "" } ] } } } ] } ] }