Skip to main content

Search

api_get_users_json

Retrieves a list of all users from the Proxima CRM system. You can optionally filter the list by specific user IDs.

Request

Endpoint

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

Authentication

Bearer Token (required)

Request Structure

Headers

Key Value
Authorization Bearer <token>
Content-Type application/json

Request Body

{
  "function": "api_get_users_json",
  "format": "json",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Field Type Required Description
function string Yes The name of the method to call. Use “api_get_users_json” for this request
format string Yes The response format - json
arguments object Optional Optional arguments specific to the method
ids string Optional A comma-separated list of user IDs from the Proxima CRM database. Only users with matching IDs will be returned. If omitted, all users will be returned

Successful Response

200 OK

Example Response

[
    {
        "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
    }
]
Field Description
name Full name of the user
manager Direct manager of the user
country Country where the user is working
region Regions (oblasts) where the user is operating
direction Product direction or line
position Job title or position of the user
Active Active status: 0 = active, 1 = inactive
user_id Internal Proxima CRM database user ID
workstartdate Date when the user started working
workenddate Date when the user's work ends
role System role of the user (e.g., ROLE_USER, ROLE_ADMIN)

Error Responses

40x/50x

{
  "message": "string"
}
Code Range Description
400-499 Client-side error (e.g., bad token)
500-599 Server-side error (e.g., job failure)