api_get_users – Proxima Research Ukraine

Отримує список усіх користувачів системи 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",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}

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

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

200 OK

В залежності від вказаного формату (csv), система повертає перелік користувачів у вигляді простого тексту.

Content-type

text/plain

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

name,manager,country,region,direction,position,active,user_id,workstartdate,workenddate,role
Ivan Petrov,A. Sidorov,Ukraine,Kyiv,RX,Medical Rep,0,12,2022-05-01,2025-05-01,ROLE_USER

Поле	Опис
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	Помилка на стороні сервера

Пошук