Przejdź do głównej treści
GET
Wyświetl listę profili pacjentów dostępnych dla twojego klucza API lub wyszukaj profil po dokładnym adresie e-mail. Gdy podasz email, endpoint wyszukuje dokładne dopasowanie w pamięci podręcznej Redis względem kanonicznego adresu e-mail do logowania i zwraca 0 lub 1 wynik; parametry limit i offset są wtedy ignorowane. Gdy go pominiesz, endpoint zwraca stronicowaną listę profili ograniczoną do kontekstu dostępu twojego klucza API. Dopasowanie adresu e-mail jest dokładne i nie uwzględnia wielkości liter — wyszukiwanie po fragmencie ani prefiksie nie jest obsługiwane. Sprawdzany jest wyłącznie kanoniczny adres e-mail do logowania; alternatywne adresy, takie jak work_email, nie są brane pod uwagę. Wymaga zakresu profiles_view lub impersonate.

Żądanie

Parametry zapytania

string
Filtruj po dokładnym adresie e-mail (bez rozróżniania wielkości liter). Po ustawieniu zwraca 0 lub 1 wynik, a limit/offset są ignorowane. Wyszukiwanie obsługuje odwrócony indeks w pamięci podręcznej Redis z zapasowym indeksowanym zapytaniem SQL.
integer
domyślnie:"100"
Maksymalna liczba zwracanych profili. Domyślnie 100, maksymalnie 500. Ignorowane, gdy ustawiono email.
integer
domyślnie:"0"
Liczba profili do pominięcia na potrzeby stronicowania. Domyślnie 0. Ignorowane, gdy ustawiono email.

Odpowiedź

Po pomyślnym wykonaniu API zwraca 200 OK z tablicą obiektów profilu. Struktura każdego elementu odpowiada Pobierz profil.
string
wymagane
Unikalny identyfikator profilu (UUID).
string
Handle lub nazwa użytkownika profilu. Może mieć wartość null.
string
Imię. Może mieć wartość null.
string
Nazwisko. Może mieć wartość null.
string
Adres e-mail. Może mieć wartość null.
string
Numer telefonu w formacie E.164. Może mieć wartość null.
integer
Płeć biologiczna wg ISO/IEC 5218 (0 = nieznana, 1 = męska, 2 = żeńska). Może mieć wartość null.
string
Data urodzenia w formacie YYYY-MM-DD. Może mieć wartość null.
number
Wzrost w centymetrach. Może mieć wartość null.
number
Masa ciała w kilogramach. Może mieć wartość null.
string
Preferowany język: 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 lub uk.
boolean
Czy ten profil otrzymuje e-maile transakcyjne (automatyczne). null, jeśli nigdy nie ustawiono.
string
Znacznik czasu ISO 8601 utworzenia profilu.
string
Znacznik czasu ISO 8601 ostatniej aktualizacji. Może mieć wartość null.

Uwagi dotyczące działania

  • Pusta tablica jest zwracana zarówno wtedy, gdy żaden profil nie pasuje do adresu e-mail, jak i wtedy, gdy dopasowanie istnieje poza twoim kontekstem dostępu. Jest to zamierzone — zapobiega ujawnianiu istnienia profili, których nie możesz odczytać.
  • Nowo utworzone profile można od razu wyszukać po email, ponieważ proces tworzenia synchronicznie zasila pamięć podręczną.
  • Niefiltrowana lista jest sortowana malejąco według created_at (od najnowszych) i stronicowana za pomocą limit oraz offset.

Powtarzane wywołania

Aniva przechowuje odpowiedź tego punktu końcowego przez 5 minut dla każdego klucza API. Ponowne wywołanie w tym czasie zwraca zapisaną odpowiedź. Nagłówki Cache-Status i Age pokazują, że odpowiedź jest zapisana i jaki jest jej wiek. Aby od razu dowiedzieć się o zmianie, zasubskrybuj zdarzenia webhooka profile.created, profile.updated i profile.deleted. Zobacz Powtarzane odczyty.

Odpowiedzi z błędami