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

# Kunden des Benutzers auflisten

> Alle Kunden, in denen der angemeldete Benutzer Mitglied ist. Deren IDs kannst du im Header `X-Customer-Id` verwenden.



## OpenAPI

````yaml /api-reference/openapi.json get /user/customers
openapi: 3.1.0
info:
  title: NETZFABRIK API
  description: >-
    REST-API der NETZFABRIK-Plattform für Domains, DNS, Cloud-Server, Webspaces,
    E-Mail-Dienste und Konto. Authentifizierung per JWT (Authorization: Bearer)
    oder API-Token (X-API-TOKEN).
  termsOfService: https://www.netzfabrik.com/tos
  contact:
    name: NETZFABRIK GmbH
    url: https://www.netzfabrik.com
    email: info@netzfabrik.com
  license:
    name: Proprietary
    url: https://www.netzfabrik.com/license
  version: 2026-11-19-9237c1a3
servers:
  - url: https://api.netzfabrik.com
security:
  - JWT: []
  - ApiToken: []
tags:
  - name: Login
  - name: Zwei-Faktor-Authentifizierung
  - name: Passkeys
  - name: Benutzer
  - name: Konten
  - name: Kunden
  - name: Verträge
  - name: Rechnungen
  - name: Support-Tickets
  - name: Domains
  - name: Domain-Bestellungen
  - name: Premium-Domains
  - name: Inhaberwechsel
  - name: Handles (Kontakte)
  - name: Handle-Verifizierung
  - name: TLD-Daten
  - name: Domain-Preise
  - name: Preislisten-Vorlagen
  - name: Preislisten-Versionen
  - name: Preis-Überschreibungen
  - name: Preisänderungen
  - name: Domain-Aktionen
  - name: Öffentliche Preislisten
  - name: Domain-Reseller
  - name: DNS-Zonen
  - name: DNS-Records
  - name: Weiterleitungen
  - name: Cloud-Server
  - name: Cloud-Server-Vorlagen
  - name: Regionen
  - name: SSH-Keys
  - name: ISO-Images
  - name: Anwendungen
  - name: Webspaces
  - name: Webspace-Tarife
  - name: Object Storage
  - name: E-Mail-Protection
  - name: E-Mail-Security
  - name: E-Mail-Archiv
  - name: Colocation
  - name: Racks
  - name: Stromzuführungen
  - name: Interconnections
  - name: VLANs
  - name: Traffic
paths:
  /user/customers:
    get:
      tags:
        - Benutzer
      summary: Kunden des Benutzers auflisten
      description: >-
        Alle Kunden, in denen der angemeldete Benutzer Mitglied ist. Deren IDs
        kannst du im Header `X-Customer-Id` verwenden.
      operationId: getUserCustomers
      parameters:
        - name: page
          in: query
          description: The collection page number
          required: false
          deprecated: false
          schema:
            type: integer
            default: 1
          style: form
          explode: true
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: User collection
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User.Customer'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
components:
  parameters:
    CustomerId:
      name: X-Customer-Id
      in: header
      required: false
      description: >-
        Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im
        Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen
        Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und
        Schreibzugriffe beziehen sich dann auf diesen Kunden.


        Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum
        (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der
        Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden
        mit `403 Forbidden` abgewiesen, eine unbekannte ID ebenfalls.


        Die IDs der erreichbaren Kunden liefern `GET /user/customers` und `GET
        /customers/{id}/children`.
      schema:
        type: string
        example: 01JD4Q8W3N6Y2K5T7R9V0B1C2D
  schemas:
    User.Customer:
      type: object
      description: >-
        The e-mail address is unique platform-wide (case-insensitive). This is
        enforced

        by a functional unique index on LOWER(email) created in

        migrations/Version20260706130000.php. Doctrine ORM 2.x cannot map
        expression

        indexes, so it lives as raw SQL there instead of as an
        #[ORM\UniqueConstraint].
      properties:
        id:
          readOnly: true
          example: 01F9Z3ZJXZQZJZJZJZJZJZJZJZ
          type: string
        name:
          minLength: 2
          maxLength: 255
          description: The name of the customer
          example: ACME Inc.
          type: string
        customerNumber:
          readOnly: true
          type: string
        vatNumber:
          description: >-
            Updating the VAT ID always resets the validation state; the new
            value

            must be (re-)validated via VIES before reverse charge can apply
            again.
          type:
            - string
            - 'null'
        vatValidated:
          readOnly: true
          description: >-
            True once the VAT ID (vatNumber) has been positively confirmed via
            VIES

            (or the configured validation service). Only a validated EU VAT ID
            makes

            the customer eligible for reverse charge. Defaults to false — an

            unverified or unverifiable VAT ID is never treated as reverse-charge
            eligible.
          default: false
          type: boolean
        vatValidatedAt:
          readOnly: true
          description: >-
            Timestamp of the last successful VIES validation of the current VAT
            ID.
          type:
            - string
            - 'null'
          format: date-time
        billingCountryCode:
          description: ISO 3166-1 alpha-2 country code of the customer's billing address.
          type:
            - string
            - 'null'
        accounts:
          type: array
          items:
            type: string
            format: iri-reference
            example: https://example.com/
        owner:
          type: string
          format: iri-reference
          example: https://example.com/
        fynnDebtorId:
          description: >-
            Fynn-Debitor des Kunden. Nur in `/user/me` lesbar (Gruppe ME), also
            für den Kunden

            selbst: Shop und Panel geben die Kennung an die Auswertung weiter,
            damit sich

            Besuche später der Abrechnung zuordnen lassen (ARC-211). `null`,
            solange das

            Onboarding den Debitor noch nicht angelegt hat oder der Kunde über
            den Elternkunden

            abgerechnet wird.
          type:
            - string
            - 'null'
        zammadOrganisationId:
          type:
            - string
            - 'null'
        parent:
          description: >-
            Hierarchie (Whitelabel/Reseller): Parent-Customer; null =
            Root/Brand.
          type:
            - string
            - 'null'
          format: iri-reference
          example: https://example.com/
        children:
          readOnly: true
          type: array
          items:
            type: string
            format: iri-reference
            example: https://example.com/
        path:
          description: >-
            ltree-Pfad (z. B. root.netzfabrik.child) für performante
            Hierarchie-Abfragen. Spalte in DB als LTREE (Migration).
          type:
            - string
            - 'null'
        depth:
          default: 0
          type: integer
        sandbox:
          readOnly: true
          description: 'Read-only: customer is a test account routed to sandbox registrars'
          default: false
          example: false
          type: boolean
        slug:
          type:
            - string
            - 'null'
        isResellingEnabled:
          default: false
          type: boolean
        canManageBrands:
          description: 'Capability: darf eigene Brands (Auftritte) anlegen und verwalten.'
          default: false
          type: boolean
        signupBrand:
          description: >-
            Brand, unter der dieser Customer registriert/zugeordnet wurde
            (bestimmt seinen Auftritt).
          anyOf:
            - $ref: '#/components/schemas/Brand'
            - type: 'null'
        billingMode:
          type:
            - string
            - 'null'
          enum:
            - PREPAID
            - POSTPAID
            - null
        status:
          type:
            - string
            - 'null'
        featurePolicies:
          description: >-
            Feature-Policies pro Key (ENABLED|DISABLED|CONFIGURABLE).
            JSON-Objekt: {"feature_key": "state"}.
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
        mfaPolicy:
          description: >-
            MFA obligation for this customer and its subtree
            (OPTIONAL|REQUIRED_FOR_ADMINS|REQUIRED)
          example: REQUIRED_FOR_ADMINS
          type:
            - string
            - 'null'
          enum:
            - OPTIONAL
            - REQUIRED_FOR_ADMINS
            - REQUIRED
            - null
        mfaGraceDays:
          minimum: 0
          maximum: 365
          description: Grace period in days before the MFA obligation is enforced
          example: 14
          type:
            - integer
            - 'null'
        defaultBrand:
          description: 'Pro Partner (Reseller): die als Default verwendete Brand.'
          anyOf:
            - $ref: '#/components/schemas/Brand'
            - type: 'null'
        brands:
          type: array
          items:
            $ref: '#/components/schemas/Brand'
        priceListTemplate:
          description: Zugewiesene Domain-Preislistenvorlage (für Reseller).
          type:
            - string
            - 'null'
          format: iri-reference
          example: https://example.com/
        lockedAt:
          readOnly: true
          description: 'Read-only: set when platform staff locked this customer (ISO 8601)'
          type:
            - string
            - 'null'
          format: date-time
        lockReason:
          readOnly: true
          type:
            - string
            - 'null'
        lockedBy:
          readOnly: true
          type:
            - string
            - 'null'
          format: iri-reference
          example: https://example.com/
        lockIncludesSubtree:
          readOnly: true
          default: false
          type: boolean
        responseWarnings:
          writeOnly: true
          description: >-
            Nicht persistierte Hinweise für die Antwort einer Änderung (ARC-124,
            Schnitt 3):

            z. B. `mfa_policy_tightened` mit betroffenen/benachrichtigten
            Nutzern. Wird nur vom

            `UpdateCustomerProcessor` befüllt und nie gespeichert — dasselbe
            Muster wie

            `warnings[]` in der Brand-Antwort.
          type: array
          items:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        validatedVatId:
          readOnly: true
          description: >-
            A VAT ID that has been positively confirmed and is thus usable for
            reverse charge.
          type: boolean
        selfBilling:
          readOnly: true
          description: >-
            Ein Customer ist "self-billing", wenn er einen eigenen Fynn-Debitor
            besitzt.
          type: boolean
        maxWebspaces:
          readOnly: true
          type: integer
        ownSandbox:
          readOnly: true
          description: Das AM KUNDEN SELBST gesetzte Kennzeichen — ohne Vererbung.
          type: boolean
        derivedRole:
          readOnly: true
          description: >-
            Derived role (ROOT|RESELLER|CUSTOMER), computed from hierarchy and
            capabilities
          example: RESELLER
          type: string
        resellingEnabled:
          readOnly: true
          type: boolean
        directReseller:
          readOnly: true
          description: >-
            Direkter Netzfabrik-Reseller (erste Ebene): direktes Kind des
            Root-Customers (depth 0)

            mit aktiviertem Reselling. Sub-Reseller (depth >= 2) und Endkunden
            sind ausgeschlossen.
          type: boolean
        directCustomer:
          readOnly: true
          description: >-
            Direktkunde der Plattform (erste Ebene unter Netzfabrik): kommt über
            einen eigenen Shop

            (Domainbunker, vaero, netzfabrik.com) oder ist ein direkter
            Reseller. Netzfabrik rechnet

            ihn selbst ab und leistet den Support; Kunden eines Resellers (depth
            >= 2) nicht.
          type: boolean
        manageBrands:
          readOnly: true
          type: boolean
        locked:
          readOnly: true
          type: boolean
        effectiveBillingMode:
          readOnly: true
          type: string
          enum:
            - PREPAID
            - POSTPAID
        prepaid:
          readOnly: true
          type: boolean
        warnings:
          readOnly: true
          description: >-
            Hinweise zur letzten Änderung (z. B. mfa_policy_tightened mit
            affectedUsers/notifiedUsers); nie persistiert
          type: array
          items:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      required:
        - name
    Error:
      type: object
      description: A representation of common errors.
      properties:
        title:
          readOnly: true
          description: A short, human-readable summary of the problem.
          type:
            - string
            - 'null'
        detail:
          readOnly: true
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type:
            - string
            - 'null'
        status:
          type:
            - integer
            - 'null'
          examples:
            - 404
          default: 400
        instance:
          readOnly: true
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem. It may or may not yield further information if
            dereferenced.
          type:
            - string
            - 'null'
        type:
          readOnly: true
          description: A URI reference that identifies the problem type
          type: string
    Brand:
      type: object
      properties:
        id:
          type: string
        customer:
          type: string
          format: iri-reference
          example: https://example.com/
        name:
          type: string
        isDefault:
          default: false
          type: boolean
        primaryDomain:
          type: string
        additionalDomains:
          type: array
          items:
            type: string
        theme:
          description: Theme / Skin (CSS-Variablen, gridscale-kompatibel).
          type:
            - object
            - 'null'
          additionalProperties:
            type:
              - string
              - 'null'
        logoUrl:
          description: Logo in der App (Header/Sidebar wenn eingeloggt).
          type:
            - string
            - 'null'
        mailLogoUrl:
          description: >-
            Logo für den Kopf der Kunden-Mails (ARC-214). Eigenes Feld, weil
            `logoUrl` dem Panel

            gehört und dort ein SVG sein darf, das Gmail/Outlook nicht anzeigen.
            Nur absolute

            https-URL auf PNG/JPG/WebP ({@see
            \App\Domain\Account\Mailer\MailLogoUrl::isAcceptedMailLogo()});

            null = Mail nutzt `logoUrl`, sonst den Brand-Namen als Text.
          type:
            - string
            - 'null'
        logoLoginUrl:
          description: Logo auf der Login-Seite.
          type:
            - string
            - 'null'
        faviconUrl:
          type:
            - string
            - 'null'
        isInheritable:
          default: true
          type: boolean
        forceBrandDownstream:
          default: false
          type: boolean
        overridesUserBranding:
          description: >-
            Wenn true: Auf dem/den Hostname(s) dieser Brand richtet sich der
            visuelle Auftritt

            NACH DIESER BRAND, egal welcher User eingeloggt ist — das
            Hostname-Branding überschreibt

            die Account-Brand (`/user/brand`) des eingeloggten Nutzers. Nur der
            VISUELLE Auftritt ist

            betroffen, NICHT Daten/Rechte/Scope.
          default: false
          type: boolean
        legal:
          description: Rechtliche Angaben / External Links (gridscale-kompatibel).
          type:
            - object
            - 'null'
          additionalProperties:
            type:
              - string
              - 'null'
        centrifugoWsUrl:
          description: Optionale Custom-Centrifugo-WS-URL für diesen Brand.
          type:
            - string
            - 'null'
        mailFromAddress:
          description: >-
            Absender-Adresse für Kunden-Mails dieser Brand (z. B.
            no-reply@domainbunker.de).
          type:
            - string
            - 'null'
        mailFromName:
          description: Absender-Name für Kunden-Mails dieser Brand (z. B. "Domainbunker").
          type:
            - string
            - 'null'
        mailReplyToAddress:
          description: Reply-To-Adresse, falls abweichend vom Absender.
          type:
            - string
            - 'null'
        supportEmail:
          description: Support-Kontakt für Header/Footer der Kunden-Mails.
          type:
            - string
            - 'null'
        zoneNameservers:
          description: DNS-Nameserver für Zonen dieses Brands (z.B. ns1.netzfabrik.ch)
          type:
            - array
            - 'null'
          items:
            type: string
        pricePlanPrefix:
          description: Prefix für Fynn-Produktnummern (z.B. "NF" → "NF-domain_com").
          type:
            - string
            - 'null'
        mfaPolicy:
          description: MFA-Untergrenze dieses Auftritts (ARC-124, Schnitt 3).
          type:
            - string
            - 'null'
          enum:
            - OPTIONAL
            - REQUIRED_FOR_ADMINS
            - REQUIRED
            - null
        default:
          readOnly: true
          type: boolean
        inheritable:
          readOnly: true
          type: boolean
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access-Token aus `POST /auth/login` (E-Mail und Passwort), gesendet als
        `Authorization: Bearer <token>`.


        Das Token ist zeitlich begrenzt gültig. Mit dem `refresh_token` aus
        derselben Antwort holt `POST /auth/token/refresh` ein neues Token-Paar,
        ohne das Passwort erneut zu senden; `POST /auth/token/invalidate` macht
        den Refresh-Token beim Abmelden ungültig.


        Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert
        der Login statt des Token-Paars `mfaRequired: true` bzw.
        `mfaEnrollmentRequired: true` und ein kurzlebiges `preAuthToken`. Mit
        diesem Token (ebenfalls als Bearer) wird der zweite Faktor über `POST
        /auth/2fa/verify` bestätigt; erst danach gibt es das volle Token-Paar.
    ApiToken:
      type: apiKey
      in: header
      name: X-API-TOKEN
      description: >-
        Persönlicher API-Token für Skripte, CI/CD und
        Server-zu-Server-Integrationen, gesendet im Header `X-API-TOKEN:
        <token>`.


        Tokens werden im Kundenpanel unter **Einstellungen → Sicherheit**
        angelegt oder per `POST /user/api-tokens` mit einem gültigen JWT. Der
        Klartext erscheint nur einmal in der Antwort beim Anlegen. Ein Token
        handelt mit den Rechten des Benutzers, der ihn erstellt hat, kann ein
        Ablaufdatum haben und wird mit `DELETE /user/api-tokens/{id}` sofort
        widerrufen.

````

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