Profiluri
Listează profilurile
Listează sau caută profiluri de pacienți după 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"
}
Listează profilurile de pacienți accesibile cheii tale API sau caută unul după adresa de e-mail exactă.
Când
email este furnizat, endpointul efectuează o căutare cu potrivire exactă din cache-ul Redis după
adresa de e-mail canonică de autentificare și returnează 0 sau 1 rezultat; limit și offset sunt ignorate în acest
caz. Când lipsește, endpointul returnează o listă paginată de profiluri limitată la contextul de acces
al cheii tale API.
Potrivirea adresei de e-mail nu ține cont de majuscule și este exactă — potrivirile parțiale sau după prefix nu sunt acceptate.
Se verifică doar adresa de e-mail canonică de autentificare; adresele alternative, precum work_email, nu sunt
luate în considerare.
Necesită scope-ul profiles_view sau impersonate.
Cerere
Parametri de interogare
Filtrează după adresa de e-mail exactă (fără a ține cont de majuscule). Când este setat, returnează 0 sau 1 rezultat, iar
limit/offset sunt ignorate. Căutarea folosește un index invers în cache Redis, cu fallback
SQL indexat.Numărul maxim de profiluri de returnat. Valoare implicită 100, maxim 500. Ignorat când
email este setat.Numărul de profiluri de omis pentru paginare. Valoare implicită 0. Ignorat când
email este setat.Răspuns
În caz de succes, API-ul returnează200 OK împreună cu un array de obiecte de profil. Structura fiecărei
intrări corespunde cu Obține profilul.
Sex biologic conform ISO/IEC 5218 (
0 = necunoscut, 1 = masculin, 2 = feminin). Poate fi null.Limba preferată:
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 sau uk.Indică dacă acest profil primește e-mailuri tranzacționale (programatice).
null dacă nu a fost setat niciodată.Note de comportament
- Se returnează un array gol atât când niciun profil nu se potrivește cu adresa de e-mail, cât și când există o potrivire în afara contextului tău de acces. Acest lucru este intenționat — împiedică endpointul să dezvăluie existența profilurilor pe care nu le poți citi.
- Profilurile nou create pot fi găsite imediat după
email, deoarece fluxul de creare populează cache-ul sincron. - Lista nefiltrată este ordonată descrescător după
created_at(cele mai noi primele) și paginată prinlimitșioffset.
Apeluri repetate
Aniva stochează răspunsul acestui endpoint timp de 5 minute pentru fiecare cheie API. Un apel repetat în acest interval primește răspunsul stocat. AnteteleCache-Status și Age arată că răspunsul este
stocat și cât de vechi este.
Pentru a afla imediat despre o modificare, abonează-te la evenimentele webhook profile.created, profile.updated și profile.deleted.
Vezi Citiri repetate.
Răspunsuri de eroare
| Status | Descriere |
|---|---|
400 | Eroare de validare — format de e-mail nevalid sau limit/offset în afara intervalului. |
403 | Interzis — cheia ta API nu are scope-ul necesar (profiles_view/impersonate). |
500 | Eroare internă de server. |
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"
}