Skip to main content
GET
Kunden des Benutzers auflisten

Authorizations

Authorization
string
header
required

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.

Headers

X-Customer-Id
string

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.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Query Parameters

page
integer
default:1

The collection page number

Response

User collection

name
string
required

The name of the customer

Required string length: 2 - 255
Example:

"ACME Inc."

id
string
read-only
Example:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

customerNumber
string
read-only
vatNumber
string | null

Updating the VAT ID always resets the validation state; the new value must be (re-)validated via VIES before reverse charge can apply again.

vatValidated
boolean
default:false
read-only

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.

vatValidatedAt
string<date-time> | null
read-only

Timestamp of the last successful VIES validation of the current VAT ID.

billingCountryCode
string | null

ISO 3166-1 alpha-2 country code of the customer's billing address.

accounts
string<iri-reference>[]
owner
string<iri-reference>
Example:

"https://example.com/"

fynnDebtorId
string | null

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.

zammadOrganisationId
string | null
parent
string<iri-reference> | null

Hierarchie (Whitelabel/Reseller): Parent-Customer; null = Root/Brand.

Example:

"https://example.com/"

children
string<iri-reference>[]
read-only
path
string | null

ltree-Pfad (z. B. root.netzfabrik.child) für performante Hierarchie-Abfragen. Spalte in DB als LTREE (Migration).

depth
integer
default:0
sandbox
boolean
default:false
read-only

Read-only: customer is a test account routed to sandbox registrars

Example:

false

slug
string | null
isResellingEnabled
boolean
default:false
canManageBrands
boolean
default:false

Capability: darf eigene Brands (Auftritte) anlegen und verwalten.

signupBrand
object | null

Brand, unter der dieser Customer registriert/zugeordnet wurde (bestimmt seinen Auftritt).

billingMode
enum<string> | null
Available options:
PREPAID,
POSTPAID,
null
status
string | null
featurePolicies
object | null

Feature-Policies pro Key (ENABLED|DISABLED|CONFIGURABLE). JSON-Objekt: {"feature_key": "state"}.

mfaPolicy
enum<string> | null

MFA obligation for this customer and its subtree (OPTIONAL|REQUIRED_FOR_ADMINS|REQUIRED)

Available options:
OPTIONAL,
REQUIRED_FOR_ADMINS,
REQUIRED,
null
Example:

"REQUIRED_FOR_ADMINS"

mfaGraceDays
integer | null

Grace period in days before the MFA obligation is enforced

Required range: 0 <= x <= 365
Example:

14

defaultBrand
object | null

Pro Partner (Reseller): die als Default verwendete Brand.

brands
object[]
priceListTemplate
string<iri-reference> | null

Zugewiesene Domain-Preislistenvorlage (für Reseller).

Example:

"https://example.com/"

lockedAt
string<date-time> | null
read-only

Read-only: set when platform staff locked this customer (ISO 8601)

lockReason
string | null
read-only
lockedBy
string<iri-reference> | null
read-only
Example:

"https://example.com/"

lockIncludesSubtree
boolean
default:false
read-only
createdAt
string<date-time>
updatedAt
string<date-time>
validatedVatId
boolean
read-only

A VAT ID that has been positively confirmed and is thus usable for reverse charge.

selfBilling
boolean
read-only

Ein Customer ist "self-billing", wenn er einen eigenen Fynn-Debitor besitzt.

maxWebspaces
integer
read-only
ownSandbox
boolean
read-only

Das AM KUNDEN SELBST gesetzte Kennzeichen — ohne Vererbung.

derivedRole
string
read-only

Derived role (ROOT|RESELLER|CUSTOMER), computed from hierarchy and capabilities

Example:

"RESELLER"

resellingEnabled
boolean
read-only
directReseller
boolean
read-only

Direkter Netzfabrik-Reseller (erste Ebene): direktes Kind des Root-Customers (depth 0) mit aktiviertem Reselling. Sub-Reseller (depth >= 2) und Endkunden sind ausgeschlossen.

directCustomer
boolean
read-only

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.

manageBrands
boolean
read-only
locked
boolean
read-only
effectiveBillingMode
enum<string>
read-only
Available options:
PREPAID,
POSTPAID
prepaid
boolean
read-only
warnings
object[]
read-only

Hinweise zur letzten Änderung (z. B. mfa_policy_tightened mit affectedUsers/notifiedUsers); nie persistiert