api_get_users – Proxima Research Español

Obtiene la lista de todos los usuarios del sistema Proxima CRM. Opcionalmente es posible filtrar la lista por identificadores específicos.

Solicitud

Endpoint

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

Autenticación

Bearer Token (obligatorio)

Estructura de la solicitud

Encabezados

Clave	Valor
Authorization	Bearer `<token>`
Content-Type	application/json

Cuerpo

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

Parámetros

Campo	Tipo	Obligatorio	Descripción
function	string	Sí	Nombre del método llamado — "api_get_users"
format	string	Sí	Formato de respuesta — csv
arguments	object	No	Parámetros opcionales
ids	string	No	Lista de IDs separados por comas; si no se especifica, se devuelven todos los usuarios

Respuesta exitosa

200 OK

En formato CSV, la respuesta se devuelve como texto plano.

Content-type

text/plain

Ejemplo de respuesta

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

Descripción de campos

Campo	Descripción
name	Nombre completo del usuario
manager	Supervisor directo
country	País de trabajo
region	Regiones de actividad
direction	Línea o dirección del producto
position	Puesto del usuario
Active	Estado: 0 = activo, 1 = inactivo
user_id	ID interno en Proxima CRM
workstartdate	Fecha de inicio
workenddate	Fecha de finalización
role	Rol del sistema (p. ej., ROLE_USER)

Respuesta de error

40x/50x

{
  "message": "string"
}

Código	Descripción
400-499	Error del cliente
500-599	Error del servidor

Búsqueda