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

Поиск

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. Для этого запроса используйте "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 Должность пользователя
user_id Внутренний ID пользователя в базе Proxima CRM
workstartdate Дата начала работы пользователя
workenddate Дата окончания работы пользователя
role Системная роль пользователя (например, ROLE_USER, ROLE_ADMIN)

Ошибочный ответ

40x/50x

{
  "message": "string"
}
Код Описание
400-499 Ошибка на стороне клиента
500-599 Ошибка на стороне сервера