CRM customers

Получить базу клиентов CRM

Собственная база CRM; в справочник контрагентов ERP клиент попадает отдельным переносом вместе с продажей или закупкой. Отбор по дополнительным полям: параметры cf.<ключ поля>=<значение>, до 10 полей. Число и флажок сравниваются по типу поля, вариант справочника - по идентификатору записи, текст - по подстроке без учёта регистра; поле, которого нет, отбирает ноль записей.

get/api/v1/crm/customers

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/customers
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Query parameters

qstring

Поиск по названию и описанию

phonestring

Телефон; сравнение идёт по нормализованным цифрам

archivedboolean

Показать архивные карточки

in_coreboolean

Только перенесённые в справочник ERP или только не перенесённые

ownerinteger

Ответственный сотрудник

limitinteger

Размер страницы

offsetinteger

Смещение страницы

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Response

Клиенты CRM

idstring uuid required
kind'person' | 'company' | 'sole_prop' required
namestring required
legal_namestring required
innstring required

ИНН без пробелов; пустая строка - не указан

kppstring required

КПП в верхнем регистре; бывает только при ИНН из 10 цифр

phonestring required

Основной телефон — значение основного канала phone

emailstring required

Основная почта — значение основного канала email

messengersobject nullable required

Ник или номер клиента по мессенджерам

tagsstring[] nullable required
sourcestring required
owner_idinteger
owner_namestring
notestring required
core_contact_idstring uuid
promoted_atstring date-time

Момент переноса в справочник контрагентов ERP

archived_atstring date-time
merged_into_customer_idstring uuid
open_dealsinteger required
customobject nullable

Дополнительные поля кабинета: состав задаёт «Настройки → Поля»

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.