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",
      "name": "Juan Perez",
      "picture_url": "http://mydomain/imgs/ddb66b137233089513fdb5d3b0c7b664130bffa2.jpg",
      "group_ids": [
        141
      ]
    },
    {
      "id": "12",
      "first_name": "Juan",
      "last_name": "García",
      "username": "pgar20",
      "email": "pgar20@example.com",
      "mobile": "+503 33830665",
      "phone": null,
      "name": "Juan García",
      "picture_url": null,
      "group_ids": [
        141
      ]
    }
  ]
}

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.