Naar hoofdinhoud gaan
GET
Geef patiëntprofielen weer waar je API-sleutel toegang toe heeft, of zoek er een op via het exacte e-mailadres. Wanneer email wordt meegegeven, voert het endpoint een in Redis gecachete exacte zoekopdracht uit op het canonieke inlog-e-mailadres en geeft 0 of 1 resultaat terug; limit en offset worden in dat geval genegeerd. Wanneer dit wordt weggelaten, geeft het endpoint een gepagineerde lijst met profielen terug binnen de toegangscontext van je API-sleutel. E-mailmatching is niet hoofdlettergevoelig en exact — substring- en prefixmatches worden niet ondersteund. Alleen het canonieke inlog-e-mailadres wordt gecontroleerd; alternatieve adressen zoals work_email worden niet meegenomen. Vereist de scope profiles_view of impersonate.

Verzoek

Queryparameters

string
Filter op exact e-mailadres (niet hoofdlettergevoelig). Indien ingesteld, geeft dit 0 of 1 resultaat terug en worden limit/offset genegeerd. De zoekopdracht loopt via een in Redis gecachete reverse index, met een geïndexeerde SQL-fallback.
integer
standaard:"100"
Maximumaantal profielen om terug te geven. Standaard 100, maximaal 500. Wordt genegeerd wanneer email is ingesteld.
integer
standaard:"0"
Aantal profielen om over te slaan voor paginering. Standaard 0. Wordt genegeerd wanneer email is ingesteld.

Respons

Bij succes geeft de API 200 OK terug met een array van profielobjecten. De structuur van elk item komt overeen met Profiel ophalen.
string
vereist
Unieke identifier van het profiel (UUID).
string
Profielhandle of gebruikersnaam. Kan null zijn.
string
Voornaam. Kan null zijn.
string
Achternaam. Kan null zijn.
string
E-mailadres. Kan null zijn.
string
Telefoonnummer in E.164-formaat. Kan null zijn.
integer
Biologisch geslacht volgens ISO/IEC 5218 (0 = onbekend, 1 = man, 2 = vrouw). Kan null zijn.
string
Geboortedatum in YYYY-MM-DD-formaat. Kan null zijn.
number
Lengte in centimeter. Kan null zijn.
number
Gewicht in kilogram. Kan null zijn.
string
Voorkeurstaal: 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 of uk.
boolean
Of dit profiel transactionele (programmatische) e-mails ontvangt. null als dit nooit is ingesteld.
string
ISO 8601-tijdstempel van het moment waarop het profiel is aangemaakt.
string
ISO 8601-tijdstempel van de laatste update. Kan null zijn.

Opmerkingen over het gedrag

  • Er wordt een lege array teruggegeven, zowel wanneer geen enkel profiel overeenkomt met het e-mailadres als wanneer er een match bestaat buiten je toegangscontext. Dit is bewust gedaan — zo voorkomt het endpoint dat het bestaan uitlekt van profielen die je niet kunt lezen.
  • Nieuw aangemaakte profielen zijn direct vindbaar via email, omdat de aanmaakflow de cache synchroon opwarmt.
  • De ongefilterde lijst wordt aflopend gesorteerd op created_at (nieuwste eerst) en gepagineerd via limit en offset.

Herhaalde aanroepen

Aniva slaat het antwoord van dit endpoint 5 minuten op per API-sleutel. Een herhaalde aanroep binnen deze tijd krijgt het opgeslagen antwoord. De headers Cache-Status en Age laten zien dat het antwoord is opgeslagen en hoe oud het is. Om direct op de hoogte te zijn van een wijziging, abonneer je je op de webhook-events profile.created, profile.updated en profile.deleted. Zie Herhaalde leesverzoeken.

Foutresponsen