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

# Domains auflisten

> Domains des aktuellen Kunden, seitenweise (`page`). Filter: `name`, `tld`, `status`, `lifecycleStatus`, `statusReason`; sortierbar über `order[...]`.



## OpenAPI

````yaml /api-reference/openapi.json get /domains
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:
  /domains:
    get:
      tags:
        - Domains
      summary: Domains auflisten
      description: >-
        Domains des aktuellen Kunden, seitenweise (`page`). Filter: `name`,
        `tld`, `status`, `lifecycleStatus`, `statusReason`; sortierbar über
        `order[...]`.
      operationId: getDomains
      parameters:
        - name: page
          in: query
          description: The collection page number
          required: false
          deprecated: false
          schema:
            type: integer
            default: 1
          style: form
          explode: true
        - name: name
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: tld
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: status
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: lifecycleStatus
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: lifecycleStatus[]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: statusReason
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: statusReason[]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: adminHandle
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: adminHandle[]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: techHandle
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: techHandle[]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: ownerHandle
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: ownerHandle[]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: zoneHandle
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
          style: form
          explode: false
        - name: zoneHandle[]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: order[name]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
          style: form
          explode: false
        - name: order[tld]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
          style: form
          explode: false
        - name: order[status]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
          style: form
          explode: false
        - name: order[lifecycleStatus]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
          style: form
          explode: false
        - name: order[registrationDate]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
          style: form
          explode: false
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: Domain collection
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Domain-domain.list'
        '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:
    Domain-domain.list:
      type: object
      properties:
        id:
          readOnly: true
          example: A1B2C3D4E5F6G7H8I9J0
          type: string
        name:
          readOnly: true
          description: >-
            A partial unique index (`uniq_domain_name_active`, see

            Version20260707100001 / Version20260831230000) enforces uniqueness
            of

            the name across active states so two concurrent orders cannot both

            create an active record for the same name. Terminal or reorderable

            states (DELETED, TRANSFERED_OUT, FAILED_REGISTRATION,
            FAILED_TRANSFER)

            are excluded — a failed order position must not block the name
            forever.
          example: example.com
          type: string
        isDomainTransferLocked:
          readOnly: true
          example: true
          type: boolean
        isAutoRenewEnabled:
          readOnly: true
          example: true
          type: boolean
        registrationDate:
          readOnly: true
          example: '2021-01-01T00:00:00+00:00'
          type: string
          format: date-time
        expiresAt:
          readOnly: true
          description: >-
            Real registrar expiry date (paid-until), synced from the registrar
            status data.
          example: '2022-01-01T00:00:00+00:00'
          type:
            - string
            - 'null'
          format: date-time
        status:
          readOnly: true
          deprecated: true
          example: online
          type: string
          enum:
            - created
            - pending
            - pendingRegistration
            - pendingTransfer
            - pendingTransferOut
            - online
            - deleted
            - pendingDelete
            - failedNameserver
            - failedRegistration
            - failedTransfer
            - unknown
            - transferedOut
            - transit
            - pendingTransit
            - zoneCreated
        lifecycleStatus:
          readOnly: true
          description: Lebenszyklus-Status des neuen Modells — genau einer je Domain.
          example: active
          type:
            - string
            - 'null'
          enum:
            - draft
            - pendingRegistration
            - pendingTransferIn
            - active
            - suspended
            - expired
            - redemption
            - pendingDelete
            - deleted
            - pendingTransferOut
            - transferredOut
            - transit
            - failed
            - attention
        statusReason:
          readOnly: true
          description: Pflichtgrund bei SUSPENDED/FAILED/ATTENTION, sonst optional.
          example: nsFailed
          type:
            - string
            - 'null'
          enum:
            - abuseHold
            - verificationPending
            - paymentHold
            - registryHold
            - registrarHold
            - nsFailed
            - registrationRejected
            - transferRejected
            - expiredNoRenewal
            - restorePending
            - customerCanceled
            - registryDeleted
            - unmappedRegistrarStatus
            - unexpectedTransition
            - notInRegistrarAccount
            - expiryUnresolved
            - deleteFailedAtRegistrar
            - renewFailedAtRegistrar
            - eventContradictsRegistrar
            - reconcileDeadlineExceeded
        flags:
          readOnly: true
          description: >-
            Registry-/Registrar-Eigenschaften, die NIE den Status ändern
            (Sperren, Auto-Renew,

            laufende Updates, DNSSEC, Claims). Als Werte von {@see DomainFlag}
            gespeichert.
          example:
            - transferLock
          type: array
          items:
            enum:
              - transferLock
              - updateLock
              - deleteLock
              - renewLock
              - autoRenew
              - pendingUpdate
              - pendingRenew
              - dnssec
              - claims
        transitType:
          readOnly: true
          example: connected
          type:
            - string
            - 'null'
          enum:
            - connected
            - disconnected
            - null
        transitAt:
          readOnly: true
          example: '2021-01-01T00:00:00+00:00'
          type:
            - string
            - 'null'
          format: date-time
        canceledAt:
          readOnly: true
          example: '2021-01-01T00:00:00+00:00'
          type:
            - string
            - 'null'
          format: date-time
        transferOutDeadlineAt:
          readOnly: true
          description: >-
            Entscheidungsfrist einer laufenden, FREMD-initiierten
            Transfer-Anfrage (Status

            `pendingTransferOut`): Zeitpunkt, zu dem die Registry ohne ACK/NACK
            automatisch

            bestätigt (TldPolicy::$transferOutAckDeadlineDays). Persistiert,
            weil das Panel den

            Countdown zeigt und der Timer-Workflow damit gestartet wird; wird
            mit der

            Kundenentscheidung bzw. dem Abschluss des Transfers wieder geleert.
          example: '2021-01-01T00:00:00+00:00'
          type:
            - string
            - 'null'
          format: date-time
        isTransferIn:
          readOnly: true
          default: false
          example: true
          type: boolean
        displayStatus:
          readOnly: true
          description: >-
            Kundentext zum Status („Aktiv", „Angehalten", „Wird geprüft") —
            keine Registrar-Begriffe.
          example: Aktiv
          type: string
        displayReason:
          readOnly: true
          description: Kundentext zum Grund; null, wenn der Status für sich spricht.
          example: Kontaktverifikation ausstehend
          type:
            - string
            - 'null'
        nextAction:
          readOnly: true
          description: Handlungsaufforderung für den Kunden (Panel-Button, Mail-CTA).
          example: none
          type: string
          enum:
            - none
            - wait
            - renew
            - restore
            - verifyContact
            - confirmTransferOut
            - fixNameservers
            - revokeCancellation
            - payInvoice
            - retryOrder
            - registerAgain
            - contactSupport
        statusSeverity:
          readOnly: true
          description: info | warning | critical — steuert die Badge-Farbe im Panel.
          example: info
          type: string
        dnsZoneId:
          readOnly: true
          example: A1234567
          type:
            - string
            - 'null'
    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
  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.