API Reference

Obtener listado de Usuarios de Clientes

Este endpoint obtiene el listado de usuarios de clientes de su empresa en CMMShere

HTTP Request

GET https://admin.cmmshere.com/api/v1/clients_users

Parámetros de consulta

Estos parámetros son opcionales y utilizados para filtrar e interactuar con la información obtenida. Los parámetros de filtrado (si se utilizan) se usan para buscar resultados que contengan dicho texto.

ParámetroTipoDefaultDescripción
usernameStringNo definidoSi se utiliza, el resultado solo incluirá usuarios de clientes que contengan ese nombre de usuario
nameStringNo definidoSi se utiliza, el resultado solo incluirá usuarios de clientes que contengan ese nombre
emailStringNo definidoSi se utiliza, el resultado solo incluirá usuarios de clientes que contengan ese email
offsetIntNo definidoOffset para paginación
limitIntNo definidoLimite para paginación
orderByArray["created_at", "desc"]Ordenamiento. El primer valor es el campo y el segundo la direccion ASC o DESC

Ejemplo de petición

curl --location --request GET 'https://demo-admin.cmmshere.com/api/v1/clients_users' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "username" : "usuario",
    "offset" : 0,
    "limit" : 10,
    "orderBy" : ["id", "asc"]
}'

La petición de arriba devuelve un JSON estructurado de la siguiente manera

{
    "success": true,
    "code": 200,
    "results": [
        {
            "id": 3,
            "username": "usuario.prueba",
            "email": "[email protected]",
            "name": "Usuario de prueba",
            "description": "Ingeniero O&M Energía",
            "active": "0",
            "created_at": "2021-08-16T19:18:28.000000Z"
        },
        {
            "id": 129,
            "username": "usuario.2",
            "email": "[email protected]",
            "name": "Usuario Dos",
            "description": "Ingeniero TIC",
            "active": "1",
            "created_at": "2024-10-03T22:25:48.000000Z"
        }
    ]
}