KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Управление
Приглашения
Отпечатки (Доступ третьим лицам)
API-ключи
Компании
GET Мои компании
POST Создать компанию
GET Проверить slug
Компания
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

Компании

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

# Получение компаний

GET
/companies/my

Возвращает список организаций, в которых состоит аккаунт.

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

RESPONSE_DATA:
application/json
companiesrequired
array
Компании
Список организаций аккаунта (AccountCompany[])
paginationrequired
array
pagination

Компания

ACCOUNT_COMPANY:
application/json
idrequired
string
ID
Уникальный идентификатор организации
namerequired
string
Название
Наименование организации
slugrequired
string
Slug
Уникальный латинский код организации
descriptionrequired
string
Описание
Краткое описание деятельности
avatar_urlrequired
string
Аватар
URL логотипа организации
is_publicrequired
boolean
Публичность
Является ли компания публичной
regionrequired
string
Регион
Основной рабочий регион
siterequired
string
Сайт
URL сайта организации
emailrequired
string
Почта
Контактный email представителя
role_coderequired
enum
ownerguest
Роль
Роль аккаунта в организации
joined_atrequired
string
Вступил
Дата вступления в организацию (RFC 3339)
created_atrequired
string
Создана
Дата регистрации организации (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

200
401
{
    "status": true,
    "message": "Companies retrieved successfully",
    "data": {
        "companies": [
            {
                "id": "660e8400-e29b-41d4-a716-446655440020",
                "name": "Автосервис на Пушкина",
                "slug": "auto-pushkina",
                "description": "Ремонт и обслуживание легковых автомобилей.",
                "avatar_url": "",
                "is_public": true,
                "region": "РФ",
                "site": "",
                "email": "",
                "role_code": "admin",
                "joined_at": "2026-04-24T00:20:54Z",
                "created_at": "2026-04-24T00:17:05Z",
                "updated_at": "2026-06-13T15:29:02Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/my",
        "method": "GET"
    }
}

# Создание компании

POST
/companies

Создаёт новую организацию. Slug генерируется автоматически из названия, но можно указать свой.

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

CREATE_REQUEST:
application/json
namerequired
string
Название
Наименование организации
slugrequired
string
Slug
Уникальный латинский код (генерируется автоматически из названия)
is_publicrequired
boolean
Публичность
Сделать визитную карточку публичной?
plan_coderequired
string
Тариф
Код тарифного плана (financier, titan, stoic)
descriptionoptional
string
Описание
Краткое описание деятельности
regionoptional
string
Регион
Основной рабочий регион (по умолчанию РФ)
promocodeoptional
string
Промокод
Промокод для увеличенного тестового периода

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

COMPANY:
application/json
idrequired
string
ID
Уникальный идентификатор организации
namerequired
string
Название
Наименование организации
slugrequired
string
Slug
Уникальный латинский код организации
descriptionrequired
string
Описание
Краткое описание деятельности
avatar_urlrequired
string
Аватар
URL логотипа организации
is_publicrequired
boolean
Публичность
Является ли компания публичной
regionrequired
string
Регион
Основной рабочий регион
siterequired
string
Сайт
URL сайта организации
emailrequired
string
Почта
Контактный email представителя
role_coderequired
enum
ownerguest
Роль
Роль аккаунта в организации
joined_atrequired
string
Вступил
Дата вступления в организацию (RFC 3339)
created_atrequired
string
Создана
Дата регистрации организации (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

201
400
{
    "status": true,
    "message": "Company created successfully",
    "data": {
        "id": "770e8400-e29b-41d4-a716-446655440030",
        "name": "МойКлад",
        "slug": "moiklad",
        "description": "Складской учёт",
        "avatar_url": "",
        "is_public": false,
        "region": "РФ",
        "site": "",
        "email": "",
        "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",
        "method": "POST"
    }
}

# Проверка уникальности slug

GET
/companies/check-slug-unique

Проверяет, свободен ли slug для создания новой организации.

Query-параметры

QUERY_PARAMS:
application/json
slugrequired
string
Slug
Проверяемый slug

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

RESPONSE_DATA:
application/json
slugrequired
string
Slug
Проверяемый slug
uniquerequired
boolean
Уникален
Свободен ли slug

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

200
/companies/check-slug-unique?slug=my-warehouse
{
    "status": true,
    "message": "Slug unique check result",
    "data": {
        "slug": "my-warehouse",
        "unique": true
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/check-slug-unique",
        "method": "GET"
    }
}