Profile
Pobierz listę profili
Pobierz listę profili pacjentów lub wyszukaj je według adresu e-mail
GET
/
api
/
v1
/
profiles
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
]
[]
{
"error": "email: Invalid email format"
}
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
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.Maksymalna liczba zwracanych profili. Domyślnie 100, maksymalnie 500. Ignorowane, gdy ustawiono
email.Liczba profili do pominięcia na potrzeby stronicowania. Domyślnie 0. Ignorowane, gdy ustawiono
email.Odpowiedź
Po pomyślnym wykonaniu API zwraca200 OK z tablicą obiektów profilu. Struktura każdego
elementu odpowiada Pobierz profil.
Płeć biologiczna wg ISO/IEC 5218 (
0 = nieznana, 1 = męska, 2 = żeńska). Może mieć wartość null.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.Czy ten profil otrzymuje e-maile transakcyjne (automatyczne).
null, jeśli nigdy nie ustawiono.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ąlimitorazoffset.
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łówkiCache-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
| Status | Opis |
|---|---|
400 | Błąd walidacji — nieprawidłowy format adresu e-mail lub limit/offset poza zakresem. |
403 | Brak dostępu — twój klucz API nie ma wymaganego zakresu (profiles_view/impersonate). |
500 | Wewnętrzny błąd serwera. |
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
]
[]
{
"error": "email: Invalid email format"
}
⌘I
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
]
[]
{
"error": "email: Invalid email format"
}