Что умеет:
GET {URL-аккаунта}/api/dev/user
{?filter=выражение}
{?page[offset]=число}
{?page[limit]=число}
Замените {URL-аккаунта} на URL экземпляра КБ, например, https://demo.clientbase.ru или http://localhost:8080/.
При вызове метода укажите заголовки:
Content-Type: application/vnd.api+json
X-Auth-Token: Ваш-токен
Для получения токена пройдите авторизацию.
При вызове метода вы можете указать параметры filter, page[offset], page[limit].
Пример: выберем из демо-конфигурации всех администраторов:
GET https://apitest.clientbase.ru/api/dev/user?filter=eq(group_id, 1)
Пример: выберем 3 администраторов:
GET https://apitest.clientbase.ru/api/dev/user?filter=eq(group_id, 1)&page[limit]=3
Пример: выберем менеджера, начиная с 2, который удовлетворяет условию:
GET https://apitest.clientbase.ru/api/dev/user?filter=eq(group_id, 2)&page[offset]=2
curl -X GET
-H 'Content-Type: application/vnd.api+json' \
-H 'X-Auth-Token: pevj1MaRq5qTUifWQ4iwVe7AcSfpGgiSCyu4T8hMfydX0Tew' \
https://apitest.clientbase.ru/api/dev/user?filter=eq(group_id, 1)&page[limit]=2
{
"data": [
{
"type": "user",
"attributes": {
"fio": "Админ",
"e_mail": "gulnara@clientbase.ru",
"login": "admin",
"group_id": 1,
"arc": 0
},
"links": {
"self": "/api/dev/user/1"
},
"id": "1"
},
{
"type": "user",
"attributes": {
"fio": "Техподдержка КБ",
"e_mail": "support@clientbase.ru",
"login": "support_cb",
"group_id": 1,
"arc": 0
},
"links": {
"self": "/api/dev/user/250"
},
"id": "250"
}
],
"links": {
"last": "http://apitest.clientbase.ru/api/dev/user?filter=eq%28group_id%2C%201%29&page%5Blimit%5D=2&page%5Boffset%5D=4",
"next": "http://apitest.clientbase.ru/api/dev/user?filter=eq%28group_id%2C%201%29&page%5Blimit%5D=2&page%5Boffset%5D=2",
"self": "http://apitest.clientbase.ru/api/dev/user?filter=eq%28group_id%2C%201%29&page%5Blimit%5D=2"
},
"jsonapi": {
"version": "1.1"
},
"meta": {
"offset": 0,
"limit": "2",
"total": 5
}
}
200 OK (application/vnd.api+json)
либо ошибка