Получение данных по клиентам
Last updated
Last updated
POST
https://api.lotinfo.ru/v1/CLIENTS
Эта конечная точка позволяет получать списки клиентов.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
"fieldType": "contact"
id
- ID контакта. value
- Значение. type
- Тип. Значения: "mobile" - мобильный телефон, "city" - городской телефон, "email" - email, "other" - другой. comment
- Комментарий. general
- Главный номер. sky
- Отслеживание.
"fieldType": "comment"
id
- ID комментария. value
- Текст комментария. date
- Дата комментария. userId
- ID пользователя, который оставил комментарий.
"fieldType": "object"
id
- ID объекта. lpr
- Лицо принимающее решения. name
- Комментарий. doled
- Доля.
"fieldType": "order"
id
- ID комментария. name
- Комментарий.
"fieldType": "media"
link
- Ссылка на документ. typeContent
- Тип контента. name
- Название документа.
"fieldType": "serviceList"
id
- ID услуги. addDate
- Дата обращения. contractStatus
- Статус договора. Значения: "open" - Действителен, "close" - Завершен. status
- Статус услуги (числом). statusText
- Статус услуги (текстом). serviceName
- Наименование услуги. comission
- Комиссия (в рублях).
"fieldType": "clientServiceList"
addDate
- Дата / Время, name
- Наименование услуги.
token*
string
Ваш токен.
nomedia
integer
Не выводить данные о медиафайлах (и документах). Может быть равно 1 или быть не указано. 1 - не выводить данные.
encoding
integer
Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
code*
integer
Код из СМС. Приходит директору агентства недвижимости. Получить код можно по ссылке: https://crm.lotinfo.ru/webMasters?getClientsBase.sendSMS
filter
object
Фильтры для поиска.
Параметры "filter":
- userId (integer)
- ID Пользователя.
- id (integer)
- ID клиента.
- apiIdExchange (integer)
- ID клиента в вашей системе.
Примечание: этот параметр вы указываете при добавлении клиента по API.
- fio (string)
- Поиск клиента по имени.
Примечание: выдаст клиентов в ФИО которых будет содержаться строка fio.
- delclient (integer)
- Статус.
Значения: 1 - Актуальные, 2 - В архиве, 3 - Удалены, 4 - Активные в рекламе.
- addDate (object)
- Дата добавления.
Параметры:
- min (optional)
- Нижний порог.
- max (optional)
- Верхний порог.
Формат: Unix time.
- editDate (object)
- Дата изменения.
Параметры:
- min (optional)
- Нижний порог.
- max (optional)
- Верхний порог.
Формат: Unix time.
- delDate (object)
- Дата удаления.
Параметры:
- min (optional)
- Нижний порог.
- max (optional)
- Верхний порог.
Формат: Unix time.
- archDate (object)
- Дата архивирования.
Параметры:
- min (optional)
- Нижний порог.
- max (optional)
- Верхний порог.
Формат: Unix time.
- typeClient (string)
- Договор.
Значения: "active" - На договоре (ЛПР), "activeIn" - На договоре (Сособственники), "nocontract" - Без договора, "arch" - Архив, "notarch" - Не в архиве.
- typeContract (string)
- Тип контракта. (Доступно, если typeClient не равен "arch").
Значения: "written", "verbal".
- clientcat (array)
- Тип и категория.
Значения: "clientc_1" - Клиенты, "clientc_2" - Контрагенты, "clientc_3" - Лиды; "clientType_-1" - Физическое лицо, "clientType_1" - Агент, "clientType_3" - Застройщик, "clientType_4" - Подрядчик, "clientType_2" - Другое.
- color (integer)
- Цвет в системе.
- pt (string)
- Потребность.
Значения: "objects" - Продажа, "orders" - Покупка, "objects_2" - Сдача в аренду, "orders_2" - Аренда, "services" - Услуги, "empty" - Пустые.
- objectTypes (array)
- Виды потребностей.
Значения:
Виды потребностей у "Продажа" и "Покупка" (pt
= "objects" или pt
= "orders"):
3 - Квартиры, 5 - Комнаты, 6 - Строящееся жилье, 7 - Склады, 8 - Индивидуальное жилье, 12 - Гаражи / паркинги, 13 - Офисы, 17 - Торговые площади, 19 - Земельные участки, 20 - Производственные помещения, 21 - Помещения свободного назначения.
Виды потребностей у "Сдача в аренду" и "Аренда" (pt
= "objects_2" или pt
= "orders_2"):
4 - Комнаты, 9 - Офисные помещения, 11 - Квартиры, 18 - Торговые помещения, 14 - Коттеджи, дома, 15 - Склады, 22 - Производственные помещения, 23 - Помещения свободного назначения.
Виды потребностей у "Услуги" (pt
= "services"): id Ваших значений.
- sex (string)
- Пол.
Значения: "male" - мужской, "female" - женский.
- regionId (integer)
- ID региона.
Примечание: regionId
не нужно указывать, если указан cityId
, он определится автоматически.
- cityid (integer)
- ID города.
- regionName (string)
- Название региона. (Поиск regionId по названию региона.)
- cityName (string)
- Название города. (Поиск cityId по названию города.)
Примечание: поиск по cityName
возможет только, если указан regionId
или regionName.
- deeps (integer)
- Правоспособность.
Значения: 1 - Малолетний, 2 - Несовершеннолетний, 3 - Совершеннолетний.
- deepon (integer)
- Дееспособность.
Значения: 1 - Дееспособный, 2 - Ограниченно дееспособный, 3 - Недееспособный.
- family (integer)
- Семейное положение.
Значения: 0 - Нет, 1 - В браке.
- userCategory (array)
- Группы клиентов.
Значения: "whatTheClient_1" - Я открыл доступ к клиентам, "whatTheClient_2" - Мне предоставлен доступ, "whatTheClient_3" - Переданные мне клиенты, "groups_all" - Все мои клиенты, "groups_notset" - Все мои клиенты без группы; id Ваших значений.
- userCategoryOut (array)
- Исключая группы клиентов.
Значения: id Ваших значений.
order
object
Поля сортировки.
Параметры "order":
- id
- ID клиента.
- addDate
- Дата добавления.
- lastWorkDate
- Дата последнего взаимодействия.
- filter1
- Статус клиента.
- editDate
- Дата изменения.
- delDate
- Дата удаления.
- archDate
- Дата архивирования.
Значения для всех полей: asc
- по возрастанию, desc
- по убыванию.
projection
array
Выводимые поля. Значения "projection": названия полей, которые необходимо вывести.
noobject
integer
Не выводить данные об объектах. Может быть равно 1 или быть не указано. 1 - не выводить данные.
limit
integer
Максимальное число выводимых клиентов. По умолчанию: 3000. Максимальное значение: 3000.
offset
integer
Сдвиг. По умолчанию: 0.