Profilok
Profilok listázása
Listázd vagy keresd meg a páciensprofilokat e-mail-cím alapján
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"
}
Listázd az API-kulcsod számára elérhető páciensprofilokat, vagy keress meg egyet pontos e-mail-cím alapján.
Ha megadod az
email paramétert, a végpont Redis-gyorsítótárazott, pontos egyezésű keresést végez a
kanonikus bejelentkezési e-mail-címen, és 0 vagy 1 találatot ad vissza; ebben az esetben a limit és az offset figyelmen kívül
marad. Ha elhagyod, a végpont az API-kulcsod hozzáférési körébe tartozó profilok lapozott listáját
adja vissza.
Az e-mail-egyeztetés nem különbözteti meg a kis- és nagybetűket, és pontos — a részszöveges és előtagos egyezést nem támogatja.
Csak a kanonikus bejelentkezési e-mail-címet ellenőrzi; az alternatív címeket, például a work_email mezőt nem
veszi figyelembe.
A profiles_view vagy az impersonate scope szükséges hozzá.
Kérés
Lekérdezési paraméterek
Szűrés pontos e-mail-cím alapján (kis- és nagybetűre nem érzékeny). Megadásakor 0 vagy 1 találatot ad vissza, és
a
limit/offset figyelmen kívül marad. A keresést egy Redis-gyorsítótárazott fordított index szolgálja ki,
indexelt SQL tartalékmegoldással.A visszaadható profilok maximális száma. Alapértelmezett értéke 100, maximuma 500. Ha az
email meg van adva, figyelmen kívül marad.A lapozáshoz átugrandó profilok száma. Alapértelmezett értéke 0. Ha az
email meg van adva, figyelmen kívül marad.Válasz
Siker esetén az API200 OK választ ad vissza profilobjektumok tömbjével. Minden
elem struktúrája megegyezik a Profil lekérése végpontéval.
Preferált nyelv:
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 vagy uk.Működési megjegyzések
- Üres tömböt kapsz vissza akkor is, ha egyetlen profil sem egyezik az e-mail-címmel, és akkor is, ha van találat a hozzáférési körödön kívül. Ez szándékos — így a végpont nem szivárogtatja ki olyan profilok létezését, amelyeket nem olvashatsz.
- Az újonnan létrehozott profilok azonnal megtalálhatók
emailalapján, mert a létrehozási folyamat szinkron módon feltölti a gyorsítótárat. - A szűretlen lista
created_atszerint csökkenő sorrendű (legújabb elöl), és alimitésoffsetsegítségével lapozható.
Ismételt hívások
Az Aniva minden API-kulcshoz 5 percig tárolja ennek a végpontnak a válaszát. Ezen az időn belül egy ismételt hívás a tárolt választ kapja vissza. ACache-Status és az Age fejléc mutatja, hogy a válasz
tárolt, és mennyi idős.
Ha azonnal értesülni szeretnél a változásokról, iratkozz fel a profile.created, profile.updated és profile.deleted webhook-eseményekre.
Lásd: Ismételt olvasások.
Hibaválaszok
| Státusz | Leírás |
|---|---|
400 | Validációs hiba — érvénytelen e-mail-formátum, vagy a limit/offset a tartományon kívül esik. |
403 | Tiltott — az API-kulcsodnak nincs meg a szükséges scope-ja (profiles_view/impersonate). |
500 | Belső szerverhiba. |
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"
}