Skip to Content
Uptimeify Docs

Kunden auflisten

Listet alle Kunden der Organisation auf.

GET /api/customers

Query-Parameter

  • organizationId (erforderlich): Die ID der Organisation.
  • fields (optional): Auf minimal setzen, um eine schlanke Struktur mit ausschließlich id, publicId, name, status und customFields zu erhalten. Monitor-Zähler und Paketdetails entfallen, und die Antwort ist deutlich kleiner. Nützlich zum Befüllen von Auswahllisten/Dropdowns.

Antwort (Response)

Mit fields=minimal:

[
  {
    "id": 101,
    "publicId": "cus_9f3a…",
    "name": "Kunde A GmbH",
    "status": "active",
    "customFields": { "region": "EU" }
  }
]

Standard-Antwort:

[
  {
    "id": 101,
    "organizationId": 1,
    "name": "Kunde A GmbH",
    "email": "kontakt@kunde-a.de",
    "packageId": 4,
    "packageDisplayName": "Business",
    "status": "active",
    "cancellationDate": null,
    "notificationEmail": "alerts@kunde-a.de",
    "createdAt": "2023-05-15T10:00:00Z",
    "statusPageCount": 2
  },
  {
    "id": 102,
    "organizationId": 1,
    "name": "StartUp XY",
    "email": "info@startup-xy.com",
    "packageId": 1,
    "packageDisplayName": "Essential",
    "status": "marked_for_cancellation",
    "cancellationDate": "2024-12-31T23:59:59Z",
    "createdAt": "2023-06-20T14:30:00Z",
    "statusPageCount": 0
  }
]

Statusseiten: Jeder Kunde trägt statusPageCount, die Zahl seiner Statusseiten, veröffentlicht oder nicht (dieselbe Zahl, gegen die das Statusseitenlimit des Pakets geprüft wird). In der geblätterten Form ist sie mit sortBy=statusPageCount sortierbar, und mit summary=1 ergänzt das summary jeder Zeile packageMaxStatusPages, die Statusseiten je Kunde, die sein Paket erlaubt (null = unbegrenzt).

Listenform: Mit envelope=items kommt die Liste als { items, total, page, perPage } und wird immer geblättert: page ist standardmäßig 1, perPage 10 (höchstens 100), mit denselben Filtern und derselben Sortierung wie mit page (search, status, packageTypes, sortBy, sortOrder, summary); packageOptions entfällt. Mit fields=minimal kommen alle Kunden in der Kurzform als eine einzige Seite. Ohne den Parameter antwortet der Endpunkt noch in der bisherigen Form; sie ist veraltet, ab dem 18.01.2027 ist { items, ... } der Standard.

Hinweis: Die Listen-Response liefert absichtlich keinen rohen packageType mehr. Verwende packageDisplayName für Anzeigezwecke und packageId für technische Zuordnung. packageDisplayName stammt aus der zugewiesenen Organisations-Paketkonfiguration und kann deshalb organisationsspezifisch sein.

Auf dieser Seite