Kunden auflisten

Dieser Endpoint gibt eine Liste aller Kunden zurück, die mit der Identität aus dem API-Schlüssel verknüpft sind.

Endpoint-Details

HTTP-Methode: GET

URL: /api/external/v1/customers

Authentifizierung: API-Schlüssel (erforderlich)

Parameter

Header

Header	Typ	Erforderlich	Beschreibung
X-Api-Key	string	Ja	API-Schlüssel für die Authentifizierung

Response

Erfolgreiche Response (200 OK)

{
  "customers": [
    {
      "id": 12345,
      "firstname": "Max",
      "lastname": "Mustermann",
      "birthday": "1990-05-15T00:00:00",
      "email": "max.mustermann@example.com",
      "externalId": "ext-123",
      "gusId": "gus-456"
    }
  ],
  "success": true,
  "errorMessage": null
}

Fehlerhafte Response (401 Unauthorized)

{
  "customers": [],
  "success": false,
  "errorMessage": "Unauthorized"
}

Response-Felder

Feld	Typ	Beschreibung
customers	array	Liste der Kunden
success	boolean	Gibt an, ob die Anfrage erfolgreich war
errorMessage	string?	Fehlermeldung, falls ein Fehler aufgetreten ist (ansonsten null)

Customer-Felder

Feld	Typ	Beschreibung
id	long	Die ID des Kunden
firstname	string	Vorname
lastname	string	Nachname
birthday	DateTime	Geburtsdatum
email	string	E-Mail-Adresse
externalId	string	Externe Kunden-ID
gusId	string	GUS-ID des Kunden

Status-Codes

Code	Beschreibung
200	OK - Anfrage wurde verarbeitet (prüfe success-Feld)
401	Unauthorized - API-Schlüssel ist ungültig oder fehlt
500	Internal Server Error - Interner Serverfehler

Funktionsweise

1. Authentifizierung über API-Schlüssel
2. Abruf der Kunden aus dem Cache für die zugehörige Identität
3. Archivierte Kunden werden nicht zurückgegeben
4. Rückgabe der Kundenliste

Wichtige Hinweise

• Es werden nur Kunden zurückgegeben, die mit der Identität aus dem API-Schlüssel verknüpft sind
• Archivierte Kunden sind nicht in der Liste enthalten
• Die Daten werden aus dem Cache gelesen, daher kann es eine kurze Verzögerung bis zu den neuesten Änderungen geben