Profili
Iegūt profilu sarakstu
Iegūt pacientu profilu sarakstu vai meklēt tos pēc e-pasta
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"
}
Skati tavai API atslēgai pieejamo pacientu profilu sarakstu vai meklē konkrētu profilu pēc precīzas e-pasta adreses.
Ja ir norādīts
email, galapunkts veic Redis kešatmiņā saglabātu precīzas atbilstības meklēšanu pēc
kanoniskā pierakstīšanās e-pasta un atgriež 0 vai 1 rezultātu; šajā gadījumā limit un offset tiek ignorēti.
Ja tas nav norādīts, galapunkts atgriež pa lapām sadalītu profilu sarakstu tavas API
atslēgas piekļuves kontekstā.
E-pasta salīdzināšana ir reģistrnejutīga un precīza — apakšvirkņu un prefiksu atbilstības netiek atbalstītas.
Tiek pārbaudīts tikai kanoniskais pierakstīšanās e-pasts; alternatīvas adreses, piemēram, work_email, netiek
ņemtas vērā.
Nepieciešams profiles_view vai impersonate tvērums.
Pieprasījums
Vaicājuma parametri
Filtrēt pēc precīzas e-pasta adreses (reģistrnejutīgi). Kad iestatīts, atgriež 0 vai 1 rezultātu un
limit/offset tiek ignorēti. Meklēšanu apkalpo Redis kešatmiņā saglabāts apgrieztais indekss ar
indeksētu SQL rezerves risinājumu.Maksimālais atgriežamo profilu skaits. Noklusējums ir 100, maksimums 500. Tiek ignorēts, ja ir iestatīts
email.Izlaižamo profilu skaits lapošanai. Noklusējums ir 0. Tiek ignorēts, ja ir iestatīts
email.Atbilde
Veiksmes gadījumā API atgriež200 OK ar profila objektu masīvu. Katra
ieraksta struktūra atbilst Iegūt profilu.
Bioloģiskais dzimums pēc ISO/IEC 5218 (
0 = nezināms, 1 = vīrietis, 2 = sieviete). Var būt null.Vēlamā valoda:
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 vai uk.Darbības piezīmes
- Tukšs masīvs tiek atgriezts gan tad, ja e-pastam neatbilst neviens profils, gan tad, ja atbilstošais profils ir ārpus tava piekļuves konteksta. Tas ir apzināti — tā galapunkts neatklāj tādu profilu esamību, kurus tu nevari lasīt.
- Jaunizveidotie profili ir uzreiz atrodami pēc
email, jo izveides plūsma sinhroni aizpilda kešatmiņu. - Nefiltrētais saraksts ir sakārtots dilstošā secībā pēc
created_at(jaunākie vispirms) un sadalīts pa lapām arlimitunoffset.
Atkārtoti izsaukumi
Aniva saglabā šī galapunkta atbildi 5 minūtes katrai API atslēgai. Atkārtots izsaukums šajā laikā saņem saglabāto atbildi. GalvenesCache-Status un Age rāda, ka atbilde ir
saglabāta un cik veca tā ir.
Lai par izmaiņām uzzinātu uzreiz, abonē webhook notikumus profile.created, profile.updated un profile.deleted.
Skati Atkārtota lasīšana.
Kļūdu atbildes
| Statuss | Apraksts |
|---|---|
400 | Validācijas kļūda — nederīgs e-pasta formāts vai limit/offset ārpus diapazona. |
403 | Aizliegts — tavai API atslēgai nav nepieciešamā tvēruma (profiles_view/impersonate). |
500 | Iekšēja servera kļūda. |
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"
}