Получение истории сделок

Метод	`get.deals_history`
Описание	Получение истории сделок
Кому доступен	Агент, Клиент

Параметры запроса

Название	Тип	Обязательный	Описание
`access_token`	string	да	Ключ сессии аутентификации
`user_id`	number	нет	Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет	Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет	Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`filter`	object	нет	См. раздел "Критерии фильтрации"
`fields`	array	нет	См. раздел "Представление возвращаемых данных"
`sort`	array	нет	См. раздел "Сортировка данных"

Параметры ответа

Название	Тип	Фильтрация	Сортировка	Описание
`ext_id`	string	да	да	Внешний идентификатор сделки
`name`	string	да		Имя сделки
`created_date_time`	iso8601	да	да	Дата и время создания сделки
`closed_date_time`	iso8601	да	да	Дата и время закрытия сделки
`modified_stage_date_time`	iso8601	да	да	Дата и время перехода сделки в текущий этап
`contact_ext_ids`	array	да		Список контактов привязанный к сделке
`tag_ext_ids`	array	да		Идентификаторы тэгов
`main_contact_ext_id`	string	да	да	Главный контакт сделки
`employee_ext_id`	string	да		Ответственный сотрудник за сделку
`revenue`	number	да	да	Выручка по сделке
`sales_funnel_ext_id`	string	да	да	Идентификатор воронки продаж
`stage_ext_id`	string	да	да	Идентификатор этапа воронки продаж
`comments`	string	нет		Комментарий к сделке
`source`	string	да	да	Источник сделки
`is_generated`	boolean	да		Автоматически сгенерированный пропущенный этап сделки
`source`	string	да	да	Источник сделки
`communication_id`	number	да	да	Идентификатор обращения
`communication_type`	string	да	да	тип обращения

JSON структура запроса

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.deals_history",
 "params":{
  "access_token":"string",
  "user_id":"number",
  "offset":"number",
  "limit":"number",
  "filter":{

  },
  "sort":[
   {
    "field":"string",
    "order":"string"
   }
  ],
  "fields":[
   "string"
  ]
 }
}

JSON структура ответа

Копировать

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "data": [
     {
       "ext_id": "string",
       "name": "string",
       "created_date_time": "iso8601",
       "closed_date_time": "iso8601",
       "modified_stage_date_time": "iso8601",
       "contact_ext_ids": [
         "string"
       ],
       "tag_ext_ids": [
         "string"
       ],
       "employee_ext_id": "string",
       "revenue": "number",
       "sales_funnel_ext_id": "string",
       "stage_ext_id": "string",
       "comments": "string",
       "source": "string",
       "is_generated": "boolean",
       "communication_id": "number",
       "communication_type": "string"
     }
    ],
    "metadata": "object"
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"