api_get_users – Proxima Research Poland

Pobiera listę wszystkich użytkowników systemu Proxima CRM. Opcjonalnie listę można odfiltrować według wybranych identyfikatorów użytkowników.

Żądanie

Endpoint

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

Uwierzytelnianie

Bearer Token (wymagany)

Struktura żądania

Nagłówki

Klucz	Wartość
Authorization	Bearer `<token>`
Content-Type	application/json

Treść żądania

{
  "function": "api_get_users",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}

Parametry

Pole	Typ	Wymagane	Opis
function	string	Tak	Nazwa wywoływanej metody — "api_get_users"
format	string	Tak	Format odpowiedzi — csv
arguments	object	Nie	Parametry opcjonalne
ids	string	Nie	Lista ID użytkowników rozdzielonych przecinkami; jeśli brak — zwracani są wszyscy użytkownicy

Odpowiedź udana

200 OK

W formacie CSV lista użytkowników jest zwracana jako zwykły tekst.

Content-type

text/plain

Przykład odpowiedzi

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

Opis pól

Pole	Opis
name	Pełne imię i nazwisko
manager	Bezpośredni przełożony
country	Kraj pracy użytkownika
region	Regiony działalności
direction	Linia / kierunek produktu
position	Stanowisko
Active	Status aktywności: 0 = aktywny, 1 = nieaktywny
user_id	Wewnętrzny ID w systemie CRM
workstartdate	Data rozpoczęcia pracy
workenddate	Data zakończenia pracy
role	Rola systemowa użytkownika (np.: ROLE_USER, ROLE_ADMIN)

Odpowiedź błędu

40x/50x

{
  "message": "string"
}

Kod	Opis
400-499	Błąd po stronie klienta
500-599	Błąd serwera

Szukaj