Возвращает список сделок. При передаче хотя бы одного ID в параметре field_ids вывод будет дополнен значениями указанных дополнительных полей контакта.
API ver.10.0.0 Пользователь
| Запрос | |||
| Параметр | Тип | Значение | Описание |
class * | String | order | |
method * | String | get_list | |
sid * | String | — | Идентификатор сессии пользователя. |
param | |||
funnel_id | Number|Number[] | — | ID воронки. |
contact_id | Number|Number[] | — | ID контакта. |
order_status_id | Number[] | — | ID статусов. |
order_user_worker | Number[] | — | ID исполнителей. |
order_user_mentor | Number[] | — | ID ответственных. |
field_ids | Number[] | — | ID полей для выборки. |
closed | Number | — | Фильтр завершенных сделок. Если не передан — только незавершенные сделки. Допустимые значения: 0 1 |
deleted | Number | — | Фильтр удаленных сделок. Допустимые значения: 0 1 |
order_name | String | — | Фильтр по названию сделки. |
order_sum | Number | — | Фильтр по стоимости сделки. |
order_final_date | Number | — | Фильтр по дате завершения. |
order_created | Number | — | Фильтр по дате создания. |
has_fields | Number[] | — | ID дополнительных полей, значения которых нужно вернуть отдельным массивом. |
tag_ids | Number[] | — | ID меток для фильтрации. |
field_filter_ids | Object[] | — | Фильтры по значениям дополнительных полей. |
field_filter_ids.id * | Number | — | ID поля. |
field_filter_ids.value * | String|Number | — | Значение для фильтра. |
field_filter_ids.compare_type * | String | — | Тип сравнения. |
only_company | Boolean | — | Вернуть только ID контактов найденных сделок. Допустимые значения: true false |
| * – обязательные параметры | |||
| Ответ | ||
| Параметр | Тип | Описание |
response * | Object[]|Number[] | Массив объектов сделок или массив ID контактов при only_company. |
order_id * | Number | ID сделки. |
order_name * | String | Название сделки. |
order_status_id * | Number | ID статуса. |
order_user_creator * | Number | ID создателя. |
order_user_mentor * | Number|Null | ID ответственного. |
order_user_worker * | Number|Null | ID исполнителя. |
chat_id * | Number | ID чата. |
contact_id * | Number | ID контакта. |
contact_name * | String | Имя контакта. |
contact_parent_id * | Number|Null | ID родительского контакта. |
contact_deleted * | Number|Null | Дата удаления контакта. |
open_job_count * | Number | Количество открытых задач. |
job_count * | Number | Общее количество задач. |
like * | Number|Null | ID пользователя, добавившего сделку в избранное. |
tags | Object[] | Массив объектов меток сделки. |
order_sum * | Number|Null | Стоимость сделки. |
funnel_id * | Number | ID воронки. |
order_deleted * | Number|Null | Дата удаления. |
order_create_date * | Number | Дата создания. |
order_change_date * | Number|Null | Дата изменения. |
order_final_date * | Number|Null | Дата завершения. |
order_success * | Number|Null | Признак успешного завершения. Допустимые значения: 0 1 |
priority * | Number | Приоритет сделки. |
fields | Object | Объект значений выбранных дополнительных полей. |
fields.field_id | Object|Object[] | Объект значения поля или массив объектов для селект-поля; ключ соответствует ID поля. |
fields.field_id.field_value_id | Number | ID значения поля. |
fields.field_id.field_char_value | String|Number|Object|Object[] | Значение текстового или SET-поля. |
fields.field_id.field_integer_value | Number | Значение числового поля. |
fields.field_id.field_double_value | Number | Значение дробного поля. |
fields.field_id.name | String | Имя файла. |
fields.field_id.href | String | Публичная ссылка на файл. |
fields.field_id.token | String | Токен доступа к файлу. |
has_fields | Object[] | Массив объектов значений полей, переданных в has_fields. |
has_fields.field_system | Number|Null | Признак предустановленного поля: 1 или null. |
| * – обязательные параметры | ||