Hoppa till huvudinnehåll
GET
Lista patientprofiler som din API-nyckel har åtkomst till, eller slå upp en profil med exakt e-postadress. När email anges gör slutpunkten en Redis-cachad exakt matchning mot den kanoniska inloggningsadressen och returnerar 0 eller 1 resultat; limit och offset ignoreras i det fallet. När den utelämnas returnerar slutpunkten en paginerad lista över profiler som omfattas av din API-nyckels åtkomstkontext. E-postmatchningen är skiftlägesokänslig och exakt — delsträngs- och prefixmatchning stöds inte. Endast den kanoniska inloggningsadressen kontrolleras; alternativa adresser som work_email tas inte med. Kräver scope profiles_view eller impersonate.

Förfrågan

Frågeparametrar

string
Filtrera på exakt e-postadress (skiftlägesokänslig). När den anges returneras 0 eller 1 resultat och limit/offset ignoreras. Uppslagningen görs via ett Redis-cachat omvänt index, med en indexerad SQL-fallback.
integer
standard:"100"
Maximalt antal profiler som returneras. Standard är 100, max 500. Ignoreras när email anges.
integer
standard:"0"
Antal profiler att hoppa över för paginering. Standard är 0. Ignoreras när email anges.

Svar

Vid lyckat anrop returnerar API:et 200 OK med en array av profilobjekt. Strukturen för varje post motsvarar Hämta profil.
string
obligatorisk
Unikt profil-ID (UUID).
string
Alias eller användarnamn. Kan vara null.
string
Förnamn. Kan vara null.
string
Efternamn. Kan vara null.
string
E-postadress. Kan vara null.
string
Telefonnummer i E.164-format. Kan vara null.
integer
Biologiskt kön enligt ISO/IEC 5218 (0 = okänt, 1 = man, 2 = kvinna). Kan vara null.
string
Födelsedatum i formatet YYYY-MM-DD. Kan vara null.
number
Längd i centimeter. Kan vara null.
number
Vikt i kilogram. Kan vara null.
string
Föredraget språk: 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 den här profilen tar emot transaktionella (programmatiska) e-postmeddelanden. null om värdet aldrig angetts.
string
ISO 8601-tidsstämpel för när profilen skapades.
string
ISO 8601-tidsstämpel för den senaste uppdateringen. Kan vara null.

Anteckningar om beteende

  • En tom array returneras både när ingen profil matchar e-postadressen och när en träff finns utanför din åtkomstkontext. Det här är avsiktligt — det hindrar slutpunkten från att läcka att det finns profiler du inte kan läsa.
  • Nyskapade profiler går att hitta direkt via email eftersom flödet för att skapa profiler värmer cachen synkront.
  • Den ofiltrerade listan sorteras efter created_at fallande (nyast först) och pagineras via limit och offset.

Upprepade anrop

Aniva lagrar svaret från den här slutpunkten i 5 minuter per API-nyckel. Ett upprepat anrop inom den tiden får det lagrade svaret. Headerna Cache-Status och Age visar att svaret är lagrat och hur gammalt det är. För att få veta om en ändring direkt kan du prenumerera på webhook-händelserna profile.created, profile.updated och profile.deleted. Se Upprepade läsningar.

Felsvar