Перейти до основного контенту

Пошук

api_get_users_json

Отримує список усіх користувачів системи Proxima CRM. За бажанням список можна відфільтрувати за конкретними ідентифікаторами користувачів.

Запит

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Аутентифікація

Bearer Token (обов'язково)

Структура Запиту

Заголовки

Ключ Значення
Authorization Bearer <token>
Content-Type application/json

Тіло запиту

{
  "function": "api_get_users_json",
  "format": "json",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Поле Тип Обов'язкове Опис
function string Так

Ім’я викликаного методу. Для цього запиту — "api_get_users_json"
format string Так Формат відповіді - json
arguments object Так Необов’язкові аргументи, специфічні для методу
ids string Ні Список ID користувачів через кому. Якщо не вказано, повертаються всі користувачі

Успішна відповідь

200 OK

Формат

JSON

Приклад відповіді

[
    {
        "name": "Ivan Petrov",
        "role": "ROLE_USER_RM",
        "region": [
            "Kyiv"
        ],
        "country": "Ukraine",
        "manager": "A. Sidorov",
        "user_id": 7,
        "position": "MR",
        "direction": [
            "Rx"
        ],
        "workenddate": "2025-02-08",
        "workstartdate": "2025-02-08",
        "active": 0
    }
]
Поле Опис
name Повне ім’я користувача
manager Безпосередній керівник
country Країна, в якій працює користувач
region Регіони (області) діяльності користувача
direction Напрямок продукту або лінія
position Посада користувача
Active Статус активності: 0 = активний, 1 = неактивний
user_id Внутрішній ID користувача в базі Proxima CRM
workstartdate Дата початку роботи користувача
workenddate Дата завершення роботи користувача
role Системна роль користувача (наприклад, ROLE_USER, ROLE_ADMIN)

Помилкова відповідь

40x/50x

{
  "message": "string"
}
Код Значення
400-499 Помилка на стороні клієнта
500-599 Помилка на стороні сервера