1. Wiki
  2. API
  3. Получения списка контактов

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

URL метода

GET/POST contacts/get_from_filter/

Например:
https://(ваша компания).stocrm.ru/api/external/v1/contacts/get_from_filter?SID=666_abcdefgh

Параметры:
Параметр Тип Описание
FILTER array Ниже в статье
SORT array Ниже в статье
PAGE int С помощью него выбирается номер страницы
LIMIT int С помощью этого параметра указывается сколько выводить элементов на странице

Значения внутри FILTER:

 

Параметр Тип Что делает
CONTACT_ID int По пользователю, например CONTACT_ID = 6 — отобразится контакт (клиент) с этим ID
SEARCH string Поиск по Email, Фамилии. (это поле можно вводить не полностью — petr… -> petrov@mail.ru)

2) Значения внутри SORT

Ключ Значение Как сортирует
CONTACT_ID ASC/DESC По номеру (ID) контакта (клиента)

Пример полученных данных:

{
«CONTACT_ID»: 55,
«TITLE»: «CONTACT-5bb235388be6b»,
«FIRSTNAME»: «FIRSTNAME-5bb235388bea5»,
«SURNAME»: «SURNAME-5bb235388bedd»,
«MIDDLENAME»: «MIDDLENAME-5bb235388bf4b»,
«CREATOR_ID»: 3,
«UPDATER_ID»: 3,
«DATE_CREATE»: «2018-10-01 17:54:48»,
«DATE_UPDATE»: «2018-10-01 17:54:48»,
«CITY_ID»: false,
«SEGMENT_ID»: false,
«DISCOUNT»: 0,
«DISCOUNT_FOR_WORKS»: 0,
«OPENER_ID»: false,
«KIND_ID»: false,
«HODL_ID»: 1,
«DOB»: false,
«CONTACT_SUBSCRIPTION_VARIANT_ID»: false,
«CONTACT_COMMUNICATION_METHOD_ID»: 1,
«GENDER»: false,
«CONTACT_SOURCE_ID»: false,
«ACTIVE»: «Y»,
«ARCHIVE»: «N»,
«RATING»: «0.0»,
«COUNTRY_ID»: 171,
«LANGUAGE_ID»: 1,
«CURRENCY_ID»: 1,
«DATE_CREATE_TIMESTAMP»: 1538405688,
«DATE_CREATE_FRONTEND_TIMESTAMP»: 1538416488,
«DOB_FRONTEND_TIMESTAMP»: false,
«DATE_UPDATE_TIMESTAMP»: 1538405688,
«MAIN_PHONE»: «74591016459»
}

Обновлено Ноябрь 23, 2020

Related Articles