Метод «group — список групп пользователей»

Что умеет:

GET - получить список групп пользователей

Запрос

GET {URL-аккаунта}/api/dev/group
            {?filter=выражение}
            {?page[offset]=число}
            {?page[limit]=число}

Замените {URL-аккаунта} на URL экземпляра КБ, например, https://demo.clientbase.ru или http://localhost:8080/.

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

Заголовки

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

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

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

Параметры

При вызове метода вы можете указать параметры filter, page[offset], page[limit].

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

Выберем группу субадминистраторов:

curl -X GET
-H 'Content-Type: application/vnd.api+json' \
-H 'X-Auth-Token: pevj1MaRq5qTUifWQ4iwVe7AcSfpGgiSCyu4T8hMfydX0Tew' \
"https://apitest.clientbase.ru/api/dev/group?filter=eq(sub_admin, 1)"

Ответ

{
    "data": [
        {
            "type": "group",
            "attributes": {
                "name": "Субадминистратор 1"
            },
            "links": {
                "self": "/api/dev/group/780"
            },
            "id": "780"
        }
    ],
    "links": {
        "self": "http://apitest.clientbase.ru/api/dev/group?filter=eq%28sub_admin%2C%201%29"
    },
    "jsonapi": {
        "version": "1.1"
    },
    "meta": {
        "offset": 0,
        "limit": 20,
        "total": 1
    }
}

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

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

image: mail