Přejít na hlavní obsah
GET
Vypiš profily pacientů dostupné pro tvůj API klíč, nebo jeden vyhledej podle přesné e-mailové adresy. Když zadáš email, endpoint provede přesné vyhledání kešované v Redisu podle kanonického přihlašovacího e-mailu a vrátí 0 nebo 1 výsledek; limit a offset se v tom případě ignorují. Když ho vynecháš, endpoint vrátí stránkovaný seznam profilů v kontextu přístupu tvého API klíče. Porovnávání e-mailů nerozlišuje velikost písmen a vyžaduje přesnou shodu — shody podřetězců a prefixů nejsou podporovány. Kontroluje se jen kanonický přihlašovací e-mail; alternativní adresy jako work_email se nezohledňují. Vyžaduje scope profiles_view nebo impersonate.

Požadavek

Parametry dotazu

string
Filtr podle přesné e-mailové adresy (nerozlišuje velikost písmen). Když je nastavený, vrátí 0 nebo 1 výsledek a limit/offset se ignorují. Vyhledávání zajišťuje reverzní index kešovaný v Redisu s indexovaným SQL fallbackem.
integer
výchozí:"100"
Maximální počet vrácených profilů. Výchozí hodnota je 100, maximum 500. Ignoruje se, když je nastavený email.
integer
výchozí:"0"
Počet profilů k přeskočení při stránkování. Výchozí hodnota je 0. Ignoruje se, když je nastavený email.

Odpověď

Při úspěchu vrátí API 200 OK s polem objektů profilů. Struktura každé položky odpovídá Načtení profilu.
string
povinné
Jedinečný identifikátor profilu (UUID).
string
Handle nebo uživatelské jméno profilu. Může být null.
string
Křestní jméno. Může být null.
string
Příjmení. Může být null.
string
E-mailová adresa. Může být null.
string
Telefonní číslo ve formátu E.164. Může být null.
integer
Biologické pohlaví podle ISO/IEC 5218 (0 = neznámé, 1 = muž, 2 = žena). Může být null.
string
Datum narození ve formátu YYYY-MM-DD. Může být null.
number
Výška v centimetrech. Může být null.
number
Hmotnost v kilogramech. Může být null.
string
Preferovaný jazyk: 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 nebo uk.
boolean
Zda tento profil přijímá transakční (automatické) e-maily. null, pokud nebylo nikdy nastaveno.
string
Časové razítko ISO 8601 vytvoření profilu.
string
Časové razítko ISO 8601 poslední aktualizace. Může být null.

Poznámky k chování

  • Prázdné pole se vrátí jak tehdy, když e-mailu neodpovídá žádný profil, tak když shoda existuje mimo tvůj kontext přístupu. Je to záměrné — brání to endpointu prozradit existenci profilů, které nemůžeš číst.
  • Nově vytvořené profily lze okamžitě dohledat podle email, protože proces vytvoření synchronně naplní cache.
  • Nefiltrovaný seznam je seřazený podle created_at sestupně (od nejnovějších) a stránkovaný přes limit a offset.

Opakovaná volání

Aniva ukládá odpověď tohoto endpointu po dobu 5 minut pro každý API klíč. Opakované volání v tomto čase dostane uloženou odpověď. Hlavičky Cache-Status a Age ukazují, že je odpověď uložená a jak je stará. Pokud se chceš o změně dozvědět hned, přihlas se k odběru webhook událostí profile.created, profile.updated a profile.deleted. Viz Opakovaná čtení.

Chybové odpovědi