List users

GET /api/usuario Returns a paginated list of users joined with their profile name. Results are ordered by id descending, with a fixed page size of 5 records.

Query parameters

number

default:"1"

Page number to retrieve. Defaults to 1.

string

Case-insensitive substring filter applied to strNombreUsuario. Uses SQL ILIKE '%value%'.

number

Filter results to users belonging to the given profile ID.

string

Filter by active status. Pass "true" for active users or "false" for inactive users. Omit to return all users regardless of status.

Response

boolean

required

true when the query completes without error.

object[]

required

Array of user objects for the requested page.

Show user object properties

number

Primary key of the user.

string

Username.

string

Email address.

string | null

Phone number. null if not set.

string | null

Cloudinary URL of the user’s profile image. null if not uploaded.

boolean

true if the user is active, false if inactive.

number

Foreign key to the perfil table.

string | null

Human-readable profile name from a LEFT JOIN on the perfil table. null if the profile record does not exist.

number

required

Total number of pages available given the current filters and a page size of 5.

Error response

When an unexpected server error occurs the handler catches the exception and returns:

500

{
  "success": false,
  "message": "Ocurrió un error al consultar los usuarios."
}

Examples

curl --request GET \
  --url 'https://your-domain.com/api/usuario?page=1&search=admin&idPerfil=1&estado=true' \
  --cookie 'auth_token=<your-jwt>'

const params = new URLSearchParams({
  page: '1',
  search: 'admin',
  idPerfil: '1',
  estado: 'true',
});

const response = await fetch(`/api/usuario?${params}`, {
  credentials: 'include', // sends the auth_token cookie
});

const { success, data, totalPages } = await response.json();

Success response

200

{
  "success": true,
  "data": [
    {
      "id": 5,
      "strNombreUsuario": "admin",
      "strCorreo": "admin@example.com",
      "strNumeroCelular": "555-1234",
      "imagenUrl": "https://res.cloudinary.com/demo/image/upload/usuarios_corp/sample.jpg",
      "idEstadoUsuario": true,
      "idPerfil": 1,
      "nombrePerfil": "Administrador"
    }
  ],
  "totalPages": 3
}

Authentication

Users

Profiles

Modules

Permissions

Query parameters

Response

Error response

Examples

Success response

​Query parameters

​Response

​Error response

​Examples

​Success response

Query parameters

Response

Error response

Examples

Success response