Profiilit
Listaa profiilit
Listaa potilasprofiilit tai hae niitä sähköpostiosoitteella
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"
}
Listaa API-avaimesi käytettävissä olevat potilasprofiilit tai hae yksittäinen profiili tarkalla sähköpostiosoitteella.
Kun
email annetaan, päätepiste tekee Redis-välimuistitetun tarkan haun
varsinaisesta kirjautumissähköpostiosoitteesta ja palauttaa 0 tai 1 tulosta; limit- ja offset-parametrit ohitetaan tällöin.
Kun se jätetään pois, päätepiste palauttaa sivutetun listan profiileista API-avaimesi
käyttöoikeusalueen mukaan rajattuna.
Sähköpostin täsmäys on kirjainkoosta riippumaton ja tarkka — osamerkkijono- ja etuliitehakuja ei tueta.
Vain varsinainen kirjautumissähköpostiosoite tarkistetaan; vaihtoehtoisia osoitteita, kuten work_email, ei
huomioida.
Vaatii profiles_view- tai impersonate-käyttöoikeuden.
Pyyntö
Kyselyparametrit
Suodata tarkan sähköpostiosoitteen mukaan (kirjainkoosta riippumaton). Kun arvo on asetettu, palauttaa 0 tai 1 tulosta ja
limit/offset ohitetaan. Haku palvellaan Redis-välimuistitetusta käänteisindeksistä, ja varajärjestelmänä toimii
indeksoitu SQL-haku.Palautettavien profiilien enimmäismäärä. Oletus on 100, enimmäismäärä 500. Ohitetaan, kun
email on asetettu.Sivutusta varten ohitettavien profiilien määrä. Oletus on 0. Ohitetaan, kun
email on asetettu.Vastaus
Onnistuessaan API palauttaa tilan200 OK ja taulukon profiiliobjekteja. Kunkin
alkion rakenne vastaa Hae profiili -päätepistettä.
Biologinen sukupuoli ISO/IEC 5218 -standardin mukaan (
0 = tuntematon, 1 = mies, 2 = nainen). Voi olla null.Ensisijainen kieli:
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 tai uk.Vastaanottaako profiili tapahtumapohjaisia (ohjelmallisia) sähköposteja.
null, jos arvoa ei ole koskaan asetettu.Huomioita toiminnasta
- Tyhjä taulukko palautetaan sekä silloin, kun yksikään profiili ei vastaa sähköpostia, että silloin, kun osuma on käyttöoikeusalueesi ulkopuolella. Tämä on tarkoituksellista — se estää päätepistettä paljastamasta sellaisten profiilien olemassaoloa, joita et voi lukea.
- Vasta luodut profiilit ovat heti haettavissa
email-osoitteella, koska luontiprosessi päivittää välimuistin synkronisesti. - Suodattamaton lista on järjestetty
created_at-kentän mukaan laskevasti (uusin ensin) ja sivutettulimit- jaoffset-parametreilla.
Toistuvat kutsut
Aniva tallentaa tämän päätepisteen vastauksen 5 minuutiksi kullekin API-avaimelle. Tämän ajan sisällä tehty toistuva kutsu saa tallennetun vastauksen. OtsikotCache-Status ja Age kertovat, että vastaus on
tallennettu ja kuinka vanha se on.
Saat tiedon muutoksista heti tilaamalla webhook-tapahtumat profile.created, profile.updated ja profile.deleted.
Katso Toistuvat lukupyynnöt.
Virhevastaukset
| Tila | Kuvaus |
|---|---|
400 | Validointivirhe — virheellinen sähköpostimuoto tai limit/offset sallitun alueen ulkopuolella. |
403 | Kielletty — API-avaimellasi ei ole vaadittua käyttöoikeutta (profiles_view/impersonate). |
500 | Palvelimen sisäinen virhe. |
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"
}