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

Приглашения в компанию

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

# Получение приглашений

GET
/companies/{id}/accounts/invitations

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

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

RESPONSE_DATA:
application/json
invitationsrequired
array
Приглашения
Список приглашений (CompanyInvitation[])
paginationrequired
array
pagination

Приглашение

INVITATION:
application/json
idrequired
string
ID
Уникальный идентификатор приглашения
company_idrequired
string
ID компании
Идентификатор организации
emailrequired
string
Почта
Email, на который отправлено приглашение
statusrequired
enum
waitingacceptedrejected
Статус
Статус приглашения
role_coderequired
enum
ownerguest
Роль
Назначенная роль
created_atrequired
string
Создано
Дата создания (RFC 3339)
updated_atrequired
string
Обновлено
Дата последнего изменения (RFC 3339)

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

200
{
    "status": true,
    "message": "Invitations retrieved successfully",
    "data": {
        "invitations": [
            {
                "id": "990e8400-e29b-41d4-a716-446655440080",
                "company_id": "660e8400-e29b-41d4-a716-446655440020",
                "email": "newuser@example.com",
                "status": "pending",
                "role_code": "guest",
                "created_at": "2026-06-14T12:00:00Z",
                "updated_at": "2026-06-14T12:00:00Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 20,
            "pages": 1
        }
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../accounts/invitations",
        "method": "GET"
    }
}

# Создать приглашение

POST
/companies/{id}/accounts/invitations

Отправляет приглашение новому участнику на указанный email. Если аккаунт с таким email не зарегистрирован — ему будет предложено создать его.

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

INVITE_REQUEST:
application/json
emailrequired
string
Почта
Email приглашаемого пользователя
role_codeoptional
enum
ownerguest
Роль
Назначенная роль (по умолчанию guest)

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

INVITATION:
application/json
idrequired
string
ID
Уникальный идентификатор приглашения
company_idrequired
string
ID компании
Идентификатор организации
emailrequired
string
Почта
Email, на который отправлено приглашение
statusrequired
enum
waitingacceptedrejected
Статус
Статус приглашения
role_coderequired
enum
ownerguest
Роль
Назначенная роль
created_atrequired
string
Создано
Дата создания (RFC 3339)
updated_atrequired
string
Обновлено
Дата последнего изменения (RFC 3339)

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

201
{
    "status": true,
    "message": "Invitation created successfully",
    "data": {
        "id": "990e8400-e29b-41d4-a716-446655440080",
        "company_id": "660e8400-e29b-41d4-a716-446655440020",
        "email": "newuser@example.com",
        "status": "pending",
        "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/.../accounts/invitations",
        "method": "POST"
    }
}

# Отозвать приглашение

DELETE
/companies/{id}/accounts/invitations/{invitationId}

Отзывает отправленное приглашение. После отзыва пользователь не сможет принять его.

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

REVOKE_RESPONSE:
application/json
company_idrequired
string
ID компании
Идентификатор организации
invitation_idrequired
string
ID приглашения
Идентификатор отозванного приглашения
revokedrequired
boolean
Отозвано
Флаг успешного отзыва

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

200
{
    "status": true,
    "message": "Invitation revoked successfully",
    "data": {
        "company_id": "660e8400-e29b-41d4-a716-446655440020",
        "invitation_id": "990e8400-e29b-41d4-a716-446655440080",
        "revoked": true
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../accounts/invitations/...",
        "method": "DELETE"
    }
}