> ## 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.

# Benutzer auflisten

> Listet Unternehmensbenutzer einschließlich inaktiver Benutzer auf. Erfordert `auth.view_user`. Die Standardliste und Suche schließen Unternehmensadministratoren, Mitarbeiter mit Staff-Zugriff und Dienstkonten aus. Die exakte E-Mail-Suche ohne Beachtung der Groß-/Kleinschreibung umfasst auch Unternehmensadministratoren.



## OpenAPI

````yaml /de/api-reference/openapi.json get /users
openapi: 3.0.0
info:
  title: Corgea API
  version: 1.0.0
  description: >-
    API für die Interaktion mit den Scan- und
    Schwachstellenmanagement-Funktionen von Corgea
servers:
  - url: https://www.corgea.app/api/v1
    description: Produktionsserver
  - url: https://eu.corgea.app/api/v1
    description: EU-Produktionsserver
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /users:
    get:
      tags:
        - Users
      summary: Benutzer auflisten
      description: >-
        Listet Unternehmensbenutzer einschließlich inaktiver Benutzer auf.
        Erfordert `auth.view_user`. Die Standardliste und Suche schließen
        Unternehmensadministratoren, Mitarbeiter mit Staff-Zugriff und
        Dienstkonten aus. Die exakte E-Mail-Suche ohne Beachtung der
        Groß-/Kleinschreibung umfasst auch Unternehmensadministratoren.
      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: Nach E-Mail, Vor- oder Nachname filtern.
        - name: email
          in: query
          schema:
            type: string
          description: Exakte E-Mail-Suche ohne Beachtung der Groß-/Kleinschreibung.
      responses:
        '200':
          description: Anfrage erfolgreich abgeschlossen
          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: Ungültiges oder fehlendes Token
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Missing or invalid authorization header
    Forbidden:
      description: Zugriff verweigert oder Feature nicht verfügbar
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Permission denied
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: >-
        API-Key für die Authentifizierung API-Tokens inaktiver Benutzer werden
        abgelehnt.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2-Access-Token (JWT) im Authorization-Header

````

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