Zum Hauptinhalt springen
GET
Liste Patientenprofile auf, auf die dein API-Key zugreifen kann, oder schlage ein Profil anhand der exakten E-Mail-Adresse nach. Wenn email angegeben ist, führt der Endpunkt eine über Redis zwischengespeicherte exakte Suche anhand der kanonischen Anmelde-E-Mail durch und gibt 0 oder 1 Ergebnis zurück; limit und offset werden in diesem Fall ignoriert. Wird der Parameter weggelassen, gibt der Endpunkt eine paginierte Liste von Profilen im Zugriffskontext deines API-Schlüssels zurück. Der E-Mail-Abgleich erfolgt exakt und ohne Berücksichtigung der Groß- und Kleinschreibung – Teilstring- und Präfix-Treffer werden nicht unterstützt. Geprüft wird nur die kanonische Anmelde-E-Mail; alternative Adressen wie work_email werden nicht berücksichtigt. Erfordert den Scope profiles_view oder impersonate.

Anfrage

Query-Parameter

string
Nach exakter E-Mail-Adresse filtern (Groß- und Kleinschreibung wird ignoriert). Wenn gesetzt, liefert die Abfrage 0 oder 1 Ergebnis und limit/offset werden ignoriert. Die Suche erfolgt über einen Redis-gecachten Reverse-Index mit indiziertem SQL-Fallback.
integer
Standard:"100"
Maximale Anzahl zurückgegebener Profile. Standardmäßig 100, maximal 500. Wird ignoriert, wenn email gesetzt ist.
integer
Standard:"0"
Anzahl der Profile, die für die Paginierung übersprungen werden. Standardmäßig 0. Wird ignoriert, wenn email gesetzt ist.

Antwort

Bei Erfolg gibt die API 200 OK mit einem Array von Profilobjekten zurück. Die Struktur jedes Eintrags entspricht Profil abrufen.
string
erforderlich
Eindeutige Profil-ID (UUID).
string
Profil-Handle oder Benutzername. Kann null sein.
string
Vorname. Kann null sein.
string
Nachname. Kann null sein.
string
E-Mail-Adresse. Kann null sein.
string
Telefonnummer im E.164-Format. Kann null sein.
integer
Biologisches Geschlecht nach ISO/IEC 5218 (0 = unbekannt, 1 = männlich, 2 = weiblich). Kann null sein.
string
Geburtsdatum im Format YYYY-MM-DD. Kann null sein.
number
Körpergröße in Zentimetern. Kann null sein.
number
Gewicht in Kilogramm. Kann null sein.
string
Bevorzugte Sprache: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr oder uk.
boolean
Ob dieses Profil transaktionale (programmatische) E-Mails erhält. null, wenn noch nie gesetzt.
string
ISO-8601-Zeitstempel der Profilerstellung.
string
ISO-8601-Zeitstempel der letzten Aktualisierung. Kann null sein.

Hinweise zum Verhalten

  • Ein leeres Array wird sowohl zurückgegeben, wenn kein Profil zur E-Mail passt, als auch dann, wenn ein Treffer außerhalb deines Zugriffskontexts existiert. Das ist beabsichtigt – so gibt der Endpunkt keine Hinweise auf die Existenz von Profilen, die du nicht lesen kannst.
  • Neu erstellte Profile sind sofort über email auffindbar, da der Erstellungsablauf den Cache synchron aufwärmt.
  • Die ungefilterte Liste ist absteigend nach created_at sortiert (neueste zuerst) und wird über limit und offset paginiert.

Wiederholte Aufrufe

Aniva speichert die Antwort dieses Endpunkts für jeden API-Key 5 Minuten lang. Ein erneuter Aufruf innerhalb dieser Zeit erhält die gespeicherte Antwort. Die Header Cache-Status und Age zeigen, dass die Antwort gespeichert ist und wie alt sie ist. Um sofort über eine Änderung informiert zu werden, abonniere die Webhook-Events profile.created, profile.updated und profile.deleted. Siehe Wiederholte Lesezugriffe.

Fehlerantworten