Метод «group — информация о группе пользователей»

Что умеет:

GET - получить информацию о группе пользователей

Запрос

GET {URL-аккаунта}/api/dev/group/{ID-группы}

Замените {URL-аккаунта} на URL экземпляра КБ, например, https://demo.clientbase.ru или http://localhost:8080/.
Замените {ID-группы} на ID группы из базы данных (он отображается в адресной строке при переходе в настройки группы пользователей (Настройки -> Доступ -> Пользователь, например, Администратор).

img-2025-07-07-12-20-13

Заголовки

При вызове метода укажите заголовки:

Content-Type: application/vnd.api+json  
X-Auth-Token: Ваш-токен

Для получения токена пройдите авторизацию.

Пример запроса

curl -X GET
-H 'Content-Type: application/vnd.api+json' \
-H 'X-Auth-Token: pevj1MaRq5qTUifWQ4iwVe7AcSfpGgiSCyu4T8hMfydX0Tew' \
https://apitest.clientbase.ru/api/dev/group/1

Ответ

{
    "data": {
        "type": "group",
        "attributes": {
            "name": "Администратор"
        },
        "links": {
            "self": "/api/dev/group/1"
        },
        "id": "1"
    },
    "jsonapi": {
        "version": "1.1"
    }
}

Формат ответа

200 OK (application/vnd.api+json)
либо ошибка

image: mail