Spring til hovedindhold
GET
Vis patientprofiler, som din API-nøgle har adgang til, eller slå en op på eksakt e-mailadresse. Når email angives, foretager endpointet et Redis-cachet eksakt opslag mod den kanoniske login-e-mail og returnerer 0 eller 1 resultat; limit og offset ignoreres i det tilfælde. Når den udelades, returnerer endpointet en pagineret liste over profiler begrænset til din API-nøgles adgangskontekst. E-mailmatch skelner ikke mellem store og små bogstaver og er eksakt — delstrengs- og præfiksmatch understøttes ikke. Kun den kanoniske login-e-mail kontrolleres; alternative adresser som work_email tages ikke i betragtning. Kræver scopet profiles_view eller impersonate.

Forespørgsel

Forespørgselsparametre

string
Filtrer efter eksakt e-mailadresse (skelner ikke mellem store og små bogstaver). Når den er angivet, returneres 0 eller 1 resultat, og limit/offset ignoreres. Opslaget betjenes af et Redis-cachet omvendt indeks med et indekseret SQL-fallback.
integer
standard:"100"
Maksimalt antal profiler, der skal returneres. Standard er 100, maksimum 500. Ignoreres, når email er angivet.
integer
standard:"0"
Antal profiler, der skal springes over ved paginering. Standard er 0. Ignoreres, når email er angivet.

Svar

Ved succes returnerer API’et 200 OK med et array af profilobjekter. Strukturen for hvert element svarer til Hent profil.
string
påkrævet
Unikt profil-id (UUID).
string
Profil-handle eller brugernavn. Kan være null.
string
Fornavn. Kan være null.
string
Efternavn. Kan være null.
string
E-mailadresse. Kan være null.
string
Telefonnummer i E.164-format. Kan være null.
integer
Biologisk køn efter ISO/IEC 5218 (0 = ukendt, 1 = mand, 2 = kvinde). Kan være null.
string
Fødselsdato i YYYY-MM-DD-format. Kan være null.
number
Højde i centimeter. Kan være null.
number
Vægt i kilogram. Kan være null.
string
Foretrukket sprog: 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 eller uk.
boolean
Om denne profil modtager transaktionelle (automatiske) e-mails. null, hvis den aldrig er angivet.
string
ISO 8601-tidsstempel for, hvornår profilen blev oprettet.
string
ISO 8601-tidsstempel for den seneste opdatering. Kan være null.

Bemærkninger om adfærd

  • Et tomt array returneres både, når ingen profil matcher e-mailen, og når der findes et match uden for din adgangskontekst. Det er tilsigtet — det forhindrer endpointet i at afsløre, at der findes profiler, du ikke kan læse.
  • Nyoprettede profiler kan findes med det samme via email, fordi oprettelsesflowet opdaterer cachen synkront.
  • Den ufiltrerede liste sorteres efter created_at faldende (nyeste først) og pagineres via limit og offset.

Gentagne kald

Aniva gemmer svaret fra dette endpoint i 5 minutter for hver API-nøgle. Et gentaget kald inden for dette tidsrum får det gemte svar. Headerne Cache-Status og Age viser, at svaret er gemt, og hvor gammelt det er. Hvis du vil have besked om en ændring med det samme, kan du abonnere på webhook-hændelserne profile.created, profile.updated og profile.deleted. Se Gentagne læsninger.

Fejlsvar