KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Компания
Базовые действия
Хранилище
Тарификация
Участники
Логи
Документы
Поддержка
Персонал (HRM)
Финансы (FM)
Клиенты (CRM)
POST Отчёт
Источники
Клиенты
GET Список
POST Создать
GET Детали
PATCH Обновить
POST Деактивировать
POST Активировать
Аналитика
Склад (WM)
Сделки (DM)
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

Клиенты

Методы для управления клиентами организации.

# Список клиентов

GET
/companies/{id}/modules/crm/clients

Возвращает список клиентов с пагинацией и фильтрацией.

Структура ответа

RESPONSE_DATA:
application/json
clientsrequired
array
Клиенты
Список клиентов (ClientDetail[])
paginationrequired
array
pagination

Клиент

CLIENT:
application/json
idrequired
string
ID
Уникальный идентификатор клиента
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)

Детали клиента

CLIENT_DETAIL:
application/json
idrequired
string
ID
Уникальный идентификатор клиента
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)
sourcerequired
array
Источник
Источник клиента (Source)

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

GET_CLIENTS_PARAMS:
application/json
pageoptional
int
Страница
Номер страницы (по умолчанию 1)
limitoptional
int
Лимит
Записей на странице (по умолчанию 20)
typeoptional
enum
individuallegal
Тип
Фильтр по типу
statusoptional
enum
activeinactive
Статус
Фильтр по статусу
searchoptional
string
Поиск
Поиск по имени, фамилии, email
source_idoptional
string
ID источника
Фильтр по источнику

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

200
{
    "status": true,
    "message": "Clients retrieved successfully",
    "data": {
        "clients": [
            {
                "id": "d00e8400-e29b-41d4-a716-446655440090",
                "first_name": "Иван",
                "last_name": "Петров",
                "patronymic": "Иванович",
                "phone": "+79000000000",
                "email": "ivan@example.com",
                "comment": "Постоянный клиент",
                "type": "individual",
                "status": "active",
                "metadata": null,
                "created_at": "2026-06-14T12:00:00Z",
                "updated_at": "2026-06-14T12:00:00Z",
                "source": {
                    "id": "c00e8400-e29b-41d4-a716-446655440080",
                    "name": "Яндекс.Директ",
                    "type": "paid",
                    "status": "active"
                }
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/clients",
        "method": "GET"
    }
}

# Создание клиента

POST
/companies/{id}/modules/crm/clients

Создаёт нового клиента.

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

CREATE_REQUEST:
application/json
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusoptional
enum
activeinactive
Статус
Статус (по умолчанию active)
source_idrequired
string
ID источника
Идентификатор источника
metadataoptional
array
Метаданные
Дополнительные данные

Структура ответа

CLIENT_DETAIL:
application/json
idrequired
string
ID
Уникальный идентификатор клиента
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)
sourcerequired
array
Источник
Источник клиента (Source)

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

201
{
    "status": true,
    "message": "Client created successfully",
    "data": {
        "id": "d00e8400-e29b-41d4-a716-446655440091",
        "first_name": "Пётр",
        "last_name": "Сидоров",
        "patronymic": null,
        "phone": "+79000000001",
        "email": null,
        "comment": null,
        "type": "individual",
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:05:00Z",
        "source": {
            "id": "c00e8400-e29b-41d4-a716-446655440080",
            "name": "Яндекс.Директ",
            "type": "paid",
            "status": "active"
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/clients",
        "method": "POST"
    }
}

# Получение клиента

GET
/companies/{id}/modules/crm/clients/{clientId}

Возвращает детальную информацию о клиенте.

Структура ответа

CLIENT_DETAIL:
application/json
idrequired
string
ID
Уникальный идентификатор клиента
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)
sourcerequired
array
Источник
Источник клиента (Source)

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

200
{
    "status": true,
    "message": "Client retrieved successfully",
    "data": {
        "id": "d00e8400-e29b-41d4-a716-446655440090",
        "first_name": "Иван",
        "last_name": "Петров",
        "patronymic": "Иванович",
        "phone": "+79000000000",
        "email": "ivan@example.com",
        "comment": "Постоянный клиент",
        "type": "individual",
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:00:00Z",
        "updated_at": "2026-06-14T12:00:00Z",
        "source": {
            "id": "c00e8400-e29b-41d4-a716-446655440080",
            "name": "Яндекс.Директ",
            "url": "https://yandex.ru/direct",
            "type": "paid",
            "comment": "Контекстная реклама",
            "system": false,
            "status": "active",
            "metadata": null,
            "created_at": "2026-06-14T12:00:00Z",
            "updated_at": "2026-06-14T12:00:00Z"
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/clients/...",
        "method": "GET"
    }
}

# Обновление клиента

PATCH
/companies/{id}/modules/crm/clients/{clientId}

Обновляет данные клиента.

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

UPDATE_REQUEST:
application/json
first_nameoptional
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typeoptional
enum
individuallegal
Тип
Тип клиента
statusoptional
enum
activeinactive
Статус
Статус
source_idoptional
string
ID источника
Идентификатор источника
metadataoptional
array
Метаданные
Дополнительные данные

Структура ответа

CLIENT_DETAIL:
application/json
idrequired
string
ID
Уникальный идентификатор клиента
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)
sourcerequired
array
Источник
Источник клиента (Source)

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

200
{
    "status": true,
    "message": "Client updated successfully",
    "data": {
        "id": "d00e8400-e29b-41d4-a716-446655440091",
        "first_name": "Пётр",
        "last_name": "Сидоров (обновлено)",
        "patronymic": null,
        "phone": "+79000000001",
        "email": "petr@example.com",
        "comment": "Новый клиент",
        "type": "individual",
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:10:00Z",
        "source": {
            "id": "c00e8400-e29b-41d4-a716-446655440080",
            "name": "Яндекс.Директ",
            "type": "paid",
            "status": "active"
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:10:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/clients/...",
        "method": "PATCH"
    }
}

# Деактивация клиента

POST
/companies/{id}/modules/crm/clients/{clientId}/deactivate

Деактивирует клиента.

Структура ответа

CLIENT_DETAIL:
application/json
idrequired
string
ID
Уникальный идентификатор клиента
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)
sourcerequired
array
Источник
Источник клиента (Source)

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

200
{
    "status": true,
    "message": "Client deactivated successfully",
    "data": {
        "id": "d00e8400-e29b-41d4-a716-446655440091",
        "first_name": "Пётр",
        "last_name": "Сидоров (обновлено)",
        "patronymic": null,
        "phone": "+79000000001",
        "email": "petr@example.com",
        "comment": "Новый клиент",
        "type": "individual",
        "status": "inactive",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:15:00Z",
        "source": {
            "id": "c00e8400-e29b-41d4-a716-446655440080",
            "name": "Яндекс.Директ",
            "type": "paid",
            "status": "active"
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:15:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/clients/.../deactivate",
        "method": "POST"
    }
}

# Активация клиента

POST
/companies/{id}/modules/crm/clients/{clientId}/activate

Активирует деактивированного клиента.

Структура ответа

CLIENT_DETAIL:
application/json
idrequired
string
ID
Уникальный идентификатор клиента
first_namerequired
string
Имя
Имя клиента
last_nameoptional
string
Фамилия
Фамилия клиента
patronymicoptional
string
Отчество
Отчество клиента
phoneoptional
string
Телефон
Номер телефона
emailoptional
string
Почта
Email адрес
commentoptional
string
Комментарий
Комментарий
typerequired
enum
individuallegal
Тип
Тип клиента
statusrequired
enum
activeinactive
Статус
Статус
metadataoptional
array
Метаданные
Дополнительные данные
created_atrequired
string
Создан
Дата создания (RFC 3339)
updated_atrequired
string
Обновлён
Дата последнего обновления (RFC 3339)
sourcerequired
array
Источник
Источник клиента (Source)

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

200
{
    "status": true,
    "message": "Client activated successfully",
    "data": {
        "id": "d00e8400-e29b-41d4-a716-446655440091",
        "first_name": "Пётр",
        "last_name": "Сидоров (обновлено)",
        "patronymic": null,
        "phone": "+79000000001",
        "email": "petr@example.com",
        "comment": "Новый клиент",
        "type": "individual",
        "status": "active",
        "metadata": null,
        "created_at": "2026-06-14T12:05:00Z",
        "updated_at": "2026-06-14T12:20:00Z",
        "source": {
            "id": "c00e8400-e29b-41d4-a716-446655440080",
            "name": "Яндекс.Директ",
            "type": "paid",
            "status": "active"
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:20:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/crm/clients/.../activate",
        "method": "POST"
    }
}