> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corgea.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar usuarios

> Lista usuarios de la empresa, incluidos los inactivos. Requiere `auth.view_user`. La lista predeterminada y la búsqueda excluyen administradores de la empresa, personal con acceso staff y cuentas de servicio. La consulta exacta por correo, sin distinguir mayúsculas, también incluye administradores.



## OpenAPI

````yaml /es/api-reference/openapi.json get /users
openapi: 3.0.0
info:
  title: API de Corgea
  version: 1.0.0
  description: >-
    API para interactuar con las funciones de escaneo y gestión de
    vulnerabilidades de Corgea
servers:
  - url: https://www.corgea.app/api/v1
    description: Servidor de producción
  - url: https://eu.corgea.app/api/v1
    description: Servidor de producción de la UE
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /users:
    get:
      tags:
        - Users
      summary: Listar usuarios
      description: >-
        Lista usuarios de la empresa, incluidos los inactivos. Requiere
        `auth.view_user`. La lista predeterminada y la búsqueda excluyen
        administradores de la empresa, personal con acceso staff y cuentas de
        servicio. La consulta exacta por correo, sin distinguir mayúsculas,
        también incluye administradores.
      operationId: listUsers
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: page_size
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
        - name: search
          in: query
          schema:
            type: string
          description: Filtrar por correo, nombre o apellido.
        - name: email
          in: query
          schema:
            type: string
          description: Consulta exacta por correo sin distinguir mayúsculas.
      responses:
        '200':
          description: Solicitud completada correctamente
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyUser'
                  page:
                    type: integer
                  total_pages:
                    type: integer
                  total_users:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    CompanyUser:
      type: object
      properties:
        id:
          type: integer
        email:
          type: string
          format: email
        first_name:
          type: string
        last_name:
          type: string
        active:
          type: boolean
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserRole'
        created_at:
          type: string
          format: date-time
    UserRole:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
  responses:
    Unauthorized:
      description: Token no válido o ausente
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Missing or invalid authorization header
    Forbidden:
      description: Permiso denegado o función no disponible
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Permission denied
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: >-
        Clave de API para la autenticación Se rechazan los tokens de API de
        usuarios inactivos.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acceso OAuth2 (JWT) en el encabezado Authorization

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.