Listado de Usuarios

Este endpoint obtiene todo el listado de los usuarios de su empresa en CMMShere

HTTP Request

GET https://admin.cmmshere.com/api/v1/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ámetro	Tipo	Default	Descripción
username	String	No definido	Si se utiliza, el resultado solo incluirá usuarios que contengan ese nombre de usuario
name	String	No definido	Si se utiliza, el resultado solo incluirá usuarios que contengan ese nombre
ap_paterno	String	No definido	Si se utiliza, el resultado solo incluirá usuarios que contengan ese apellido paterno
ap_materno	String	No definido	Si se utiliza, el resultado solo incluirá usuarios que contengan ese apellido materno
email	String	No definido	Si se utiliza, el resultado solo incluirá usuarios que contengan ese email
offset	Int	No definido	Offset para paginación
limit	Int	No definido	Limite para paginación
orderBy	Array	["created_at", "desc"]	Ordenamiento. El primer valor es el campo y el segundo la dirección ASC o DESC

Ejemplo de petición

curl --location --request GET 'https://admin.cmmshere.com/api/v1/users' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 914|JlTKPnGaW1KfPE031VL0ahsDZN75O6kf5vLHMAOt' \
--header 'Cookie: XSRF-TOKEN=eyJpdiI6Imw3b09rb3pBRUZGZEZNdVp5bWFkcGc9PSIsInZhbHVlIjoiZ085ZG8vTHBuS2h6eUhPNEtUL0Q4RzdwdFZNQzZrTkdxQ01JWWxoYW9IUy9PaUdpcmx2WS9Mb2d5YXRCWFpOVThKR2JCeUJRZFZQZU4xZHY5N3ZCSDJScmk3YWRsZGN1Z2VodDd6N3VEYmNwZVpZNjFETUpIZjRUTnorVU9rbi8iLCJtYWMiOiJmNWU5OTAwNzA0Yzk0MDVhYmMxYmE1OTY2OWZiZjUwOTA3MDI2NGNkYTg0ZTUwMGRlMmNkMWQwOGFjMTRiYzdhIn0%3D; laravel_session=eyJpdiI6IjJhUVV6WTVaTlFUZDB4cXJhaFQvWlE9PSIsInZhbHVlIjoibXZqVXNmekJhRVZzelZNS3FUSW5WRktkYkIvYXBkMXlpTWtJWExCSi9kY0hUL0dkM1NSRDFRN3JrVjZEYi9DYUlEazlkSWR1UUxRSUJhcWswVnBObzFLYTFHb3B3SHVEekZheUtDZHEraFZmYlhxRlRMZlVEMmdwMEtudHpLZ2EiLCJtYWMiOiI3MzBhYmVkNTA4NTkwOWVlNzdjNzkwNGFkODI2MGM0YTcwNGZlZmI5MDhkOGYzNjkyMTQxNDUzZWUwZDI5MDM3In0%3D' \
--data-raw '{
    "email" : "@gmail.com",
    "offset" : 0,
    "limit" : 5,
    "orderBy" : ["id", "asc"]
}'

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

{
    "success": true,
    "code": 200,
    "results": [
        {
            "id": 23,
            "username": "Margarita.Batz",
            "name": "Margarita",
            "lastName": "Batz Flatley",
            "status": 1,
            "position": "CEO AMPER ECUADOR",
            "birthDate": "1987-03-11",
            "address": "URDENOR 1 MZ 133 VILLA 9",
            "phone": "208.498.2581",
            "cellphone": "+1-352-383-3608",
            "docNumber": "0962050746",
            "created_at": "2021-06-17T20:30:09.000000Z"
        },
        {
            "id": 37,
            "username": "Aric.Runolfsdottir",
            "name": "Aric",
            "lastName": "Runolfsdottir Howe",
            "status": 1,
            "position": "Gerente de Producto Área Distribución de Energía",
            "birthDate": "1988-08-06",
            "address": null,
            "phone": "+1 (562) 639-7857",
            "cellphone": "534.966.1374",
            "docNumber": "6187069",
            "created_at": "2021-07-09T21:15:27.000000Z"
        },
        {
            "id": 43,
            "username": "Aniya.Hodkiewicz",
            "name": "Aniya",
            "lastName": "Hodkiewicz Schowalter",
            "status": 1,
            "position": "Técnico de Aires de Precisión y Grupos Electrógenos",
            "birthDate": "1981-06-29",
            "address": null,
            "phone": "919.767.4222",
            "cellphone": "319.348.9740",
            "docNumber": "4999650 LP",
            "created_at": "2021-07-21T17:00:12.000000Z"
        },
        {
            "id": 44,
            "username": "Bertram.White",
            "name": "Bertram",
            "lastName": "White Hayes",
            "status": 1,
            "position": "Subjefe Tecnico de Energia",
            "birthDate": "1974-06-24",
            "address": null,
            "phone": "+1 (757) 928-8297",
            "cellphone": "+1 (478) 980-6536",
            "docNumber": "4801272",
            "created_at": "2021-07-21T17:50:55.000000Z"
        },
        {
            "id": 47,
            "username": "Granville.Balistreri",
            "name": "Granville",
            "lastName": "Balistreri Pfannerstill",
            "status": 1,
            "position": "Técnico de Aires de Precisión y Grupos Electrógenos",
            "birthDate": "1981-04-23",
            "address": null,
            "phone": "+1-585-786-4478",
            "cellphone": "219-538-6736",
            "docNumber": "5982054LP",
            "created_at": "2021-07-21T18:24:19.000000Z"
        }
    ]
}