api_get_users – Proxima Research

Получает список всех пользователей системы 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	Ошибка на стороне сервера

Поиск