Получение списка контактов

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

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

Название	Тип	Обязательный	Описание
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	нет		Дата и время создания контакта в CRM (YYYY-MM-DD hh:mm:ss)
phone_numbers	array	да		Список номеров контакта
emails	array	да		Адрес электронной почты контакта.

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

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

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

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

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": [
            {
                "ext_id": "string",
                "name": "string",
                "created_date_time": "iso8601",
                "phone_numbers": ["string"],
                "emails": ["string"]
            }
        ],
        "metadata": "object"
    }
}

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

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