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

Участники компании

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

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

GET
/companies/{id}/accounts

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

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

RESPONSE_DATA:
application/json
accountsrequired
array
Участники
Список участников (CompanyAccount[])
paginationrequired
array
pagination

Участник

COMPANY_ACCOUNT:
application/json
idrequired
string
ID
Уникальный идентификатор аккаунта
namerequired
string
Имя
Отображаемое имя участника
emailrequired
string
Почта
Email участника
avatar_urloptional
string
Аватар
URL аватара
role_coderequired
enum
ownerguest
Роль
Роль в организации
statusrequired
string
Статус
Статус аккаунта
joined_atrequired
string
Вступил
Дата вступления в организацию (RFC 3339)
created_atrequired
string
Создан
Дата регистрации аккаунта (RFC 3339)

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

200
{
    "status": true,
    "message": "Company accounts retrieved successfully",
    "data": {
        "accounts": [
            {
                "id": "550e8400-e29b-41d4-a716-446655440001",
                "name": "Иван Петров",
                "email": "developer@example.com",
                "avatar_url": null,
                "role_code": "owner",
                "status": "confirmed",
                "joined_at": "2026-04-24T00:20:54Z",
                "created_at": "2026-04-24T00:17:05Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../accounts",
        "method": "GET"
    }
}

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

GET
/companies/{id}/accounts/{accountId}

Возвращает данные одного участника организации.

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

COMPANY_ACCOUNT:
application/json
idrequired
string
ID
Уникальный идентификатор аккаунта
namerequired
string
Имя
Отображаемое имя участника
emailrequired
string
Почта
Email участника
avatar_urloptional
string
Аватар
URL аватара
role_coderequired
enum
ownerguest
Роль
Роль в организации
statusrequired
string
Статус
Статус аккаунта
joined_atrequired
string
Вступил
Дата вступления в организацию (RFC 3339)
created_atrequired
string
Создан
Дата регистрации аккаунта (RFC 3339)

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

200
{
    "status": true,
    "message": "Company account retrieved successfully",
    "data": {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "name": "Иван Петров",
        "email": "developer@example.com",
        "avatar_url": null,
        "role_code": "owner",
        "status": "confirmed",
        "joined_at": "2026-04-24T00:20:54Z",
        "created_at": "2026-04-24T00:17:05Z"
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../accounts/...",
        "method": "GET"
    }
}

# Разрешения участника

GET
/companies/{id}/modules/accounts/{accountId}/permissions

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

Разрешение

PERMISSION:
application/json
coderequired
string
Код
Уникальный код разрешения
lvlrequired
int
Уровень
Минимальный уровень тарифа
criticalityrequired
int
Критичность
Степень важности (1-10)
allow_expiredrequired
boolean
Просроченный доступ
Доступно ли после окончания тарифа

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

200
{
    "status": true,
    "message": "Permissions retrieved successfully",
    "data": [
        {
            "code": "fm.transactions.create",
            "lvl": 1,
            "criticality": 8,
            "allow_expired": false
        },
        {
            "code": "crm.clients",
            "lvl": 2,
            "criticality": 5,
            "allow_expired": true
        }
    ],
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/accounts/.../permissions",
        "method": "GET"
    }
}

# Настройки участника

GET
/companies/{id}/modules/accounts/{accountId}/settings

Возвращает настройки разрешений участника: добавленные и убранные разрешения.

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

ACCOUNT_SETTINGS:
application/json
account_idrequired
string
ID аккаунта
Идентификатор участника
increase_permissionsoptional
array
Добавленные
Список добавленных разрешений (string[])
reduce_permissionsoptional
array
Убранные
Список убранных разрешений (string[])
created_atrequired
string
Созданы
Дата создания настроек (RFC 3339)
updated_atrequired
string
Обновлены
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Account settings retrieved successfully",
    "data": {
        "account_id": "550e8400-e29b-41d4-a716-446655440001",
        "increase_permissions": ["fm.transactions.create"],
        "reduce_permissions": null,
        "created_at": "2026-04-24T00:20:54Z",
        "updated_at": "2026-06-14T00:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/accounts/.../settings",
        "method": "GET"
    }
}

# Обновление настроек участника

PATCH
/companies/{id}/modules/accounts/{accountId}/settings

Обновляет настройки разрешений участника. Все поля опциональны.

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

UPDATE_REQUEST:
application/json
increase_permissionsoptional
array
Добавить
Разрешения для добавления (string[])
reduce_permissionsoptional
array
Убрать
Разрешения для удаления (string[])

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

ACCOUNT_SETTINGS:
application/json
account_idrequired
string
ID аккаунта
Идентификатор участника
increase_permissionsoptional
array
Добавленные
Список добавленных разрешений (string[])
reduce_permissionsoptional
array
Убранные
Список убранных разрешений (string[])
created_atrequired
string
Созданы
Дата создания настроек (RFC 3339)
updated_atrequired
string
Обновлены
Дата последнего обновления (RFC 3339)

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

200
{
    "status": true,
    "message": "Account settings updated successfully",
    "data": {
        "account_id": "550e8400-e29b-41d4-a716-446655440001",
        "increase_permissions": ["fm.transactions.create", "crm.clients"],
        "reduce_permissions": null,
        "created_at": "2026-04-24T00:20:54Z",
        "updated_at": "2026-06-14T12:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/accounts/.../settings",
        "method": "PATCH"
    }
}

# Исключить участника

DELETE
/companies/{id}/modules/accounts/{accountId}

Исключает участника из организации. Участник теряет доступ ко всем данным компании.

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

DELETE_RESPONSE:
application/json
account_idrequired
string
ID аккаунта
Идентификатор исключённого участника
removedrequired
boolean
Исключён
Флаг успешного исключения

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

200
{
    "status": true,
    "message": "Account removed successfully",
    "data": {
        "account_id": "550e8400-e29b-41d4-a716-446655440002",
        "removed": true
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../modules/accounts/...",
        "method": "DELETE"
    }
}