API: Usuarios

M: Listar usuarios

HTTP GET:

https://<hostname>/api/user

Este método soporta el uso de filtros.

Nota: no se soporta el uso de picture_url y name en los filtros.

OUTPUT:

Json con los campos:

• success: boolean
• data: json Contiene una lista de User Data Objects

EJEMPLO CON CURL:

$ curl -u <api_key>:<password> -X GET https://<hostname>/api/user?filter_by=first_name&filter_values=Juan

RESPUESTA:

{
  "success": true,
  "data": [
    {
        "id": "22",
        "first_name": "Juan",
        "last_name": "Pérez",
        "username": "jperez",
        "email": "jperez@example.com",
        "mobile": "+501 30890999",
        "phone": "+501 22222222",
        "tracking_status": "online",
        "tracking_status_last_updated": "2025-02-24T17:17:28+00:00",
        "name": "Juan Perez",
        "picture_url": "http://mydomain/imgs/ddb66b137233089513fdb5d3b0c7b664130bffa2.jpg",
        "group_ids": [
          141
        ],
        "mobile_worker_app_enabled": true,
        "mobile_worker_app_tracking_enabled": true,
        "mobile_worker_app_account_id": 24,
        "mobile_worker_app_settings": {
            "changed_date": "2025-02-24T17:17:28+00:00",
            "battery_optimization_disabled": false,
            "access_fine_location": true,
            "access_background_location": true,
            "low_battery_mode": false
        },
        "mobile_worker_app_stats": {
            "version": "3.0.11",
            "os": "android",
            "battery_level_percentage": 100
        }
    }
  ]
}

O: User Data Object

Key	Nombre	Descripción
id	Texto	Identificador del usuario.
first_name	Texto	Primer nombre del usuario.
last_name	Texto	Apellido del usuario.
username	Texto	Nombre de usuario dentro de la plataforma (único entre todos los usuarios).
email	Texto	Correo electrónico del usuario.
mobile	Texto	Número de teléfono móvil del usuario.
phone	Texto	Número de teléfono fijo del usuario.
name	Texto	Nombre completo del usuario (es la unión de first_name y last_name).
picture_url	Texto	URL de la imagen de perfil del usuario.
group_ids	Lista de números	Lista de identificadores de los grupos a los que pertenece el usuario.
tracking_status	Texto ("online", "offline")	Estado actual del rastreo del usuario.
tracking_status_last_updated	Fecha y hora	Última actualización del estado de rastreo.
mobile_worker_app_enabled	Booleano	Indica si la aplicación Mobile Worker está habilitada para el usuario.
mobile_worker_app_tracking_enabled	Booleano	Indica si el rastreo continuo dentro de la aplicación Mobile Worker está habilitado desde el administrador de usuarios.
mobile_worker_app_account_id	Número	Identificador de la cuenta a la que se cobra la licencia de Mobile Worker.
mobile_worker_app_settings	Objeto	Configuración de la aplicación Mobile Worker.
mobile_worker_app_settings.changed_date	Fecha y hora	Fecha de la última modificación de la configuración de la aplicación.
mobile_worker_app_settings.battery_optimization_disabled	Booleano	Indica si la optimización de batería está deshabilitada.
mobile_worker_app_settings.access_fine_location	Booleano	Indica si la aplicación tiene acceso a la ubicación precisa.
mobile_worker_app_settings.access_background_location	Booleano	Indica si la aplicación tiene acceso a la ubicación en segundo plano.
mobile_worker_app_settings.low_battery_mode	Booleano	Indica si el modo de batería baja está activado.
mobile_worker_app_stats	Objeto	Información del estado de la aplicación Mobile Worker.
mobile_worker_app_stats.version	Texto	Versión de la aplicación Mobile Worker instalada.
mobile_worker_app_stats.os	Texto	Sistema operativo del dispositivo donde está instalada la aplicación.
mobile_worker_app_stats.battery_level_percentage	Número	Nivel de batería del dispositivo en porcentaje.