Profily
Vypsat profily
Vypsat nebo vyhledat profily pacientů podle e-mailu
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"
}
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
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.Maximální počet vrácených profilů. Výchozí hodnota je 100, maximum 500. Ignoruje se, když je nastavený
email.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í API200 OK s polem objektů profilů. Struktura každé
položky odpovídá Načtení profilu.
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.Zda tento profil přijímá transakční (automatické) e-maily.
null, pokud nebylo nikdy nastaveno.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_atsestupně (od nejnovějších) a stránkovaný přeslimitaoffset.
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čkyCache-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
| Stav | Popis |
|---|---|
400 | Chyba validace — neplatný formát e-mailu nebo limit/offset mimo rozsah. |
403 | Zakázáno — tvůj API klíč nemá požadovaný scope (profiles_view/impersonate). |
500 | Interní chyba serveru. |
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"
}