Profiler
Lista profiler
Lista eller slå upp patientprofiler via e-post
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"
}
Lista patientprofiler som din API-nyckel har åtkomst till, eller slå upp en profil med exakt e-postadress.
När
email anges gör slutpunkten en Redis-cachad exakt matchning mot den
kanoniska inloggningsadressen och returnerar 0 eller 1 resultat; limit och offset ignoreras i det
fallet. När den utelämnas returnerar slutpunkten en paginerad lista över profiler som omfattas av din
API-nyckels åtkomstkontext.
E-postmatchningen är skiftlägesokänslig och exakt — delsträngs- och prefixmatchning stöds inte.
Endast den kanoniska inloggningsadressen kontrolleras; alternativa adresser som work_email tas inte
med.
Kräver scope profiles_view eller impersonate.
Förfrågan
Frågeparametrar
Filtrera på exakt e-postadress (skiftlägesokänslig). När den anges returneras 0 eller 1 resultat och
limit/offset ignoreras. Uppslagningen görs via ett Redis-cachat omvänt index, med en
indexerad SQL-fallback.Maximalt antal profiler som returneras. Standard är 100, max 500. Ignoreras när
email anges.Antal profiler att hoppa över för paginering. Standard är 0. Ignoreras när
email anges.Svar
Vid lyckat anrop returnerar API:et200 OK med en array av profilobjekt. Strukturen för varje
post motsvarar Hämta profil.
Föredraget språk:
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 eller uk.Om den här profilen tar emot transaktionella (programmatiska) e-postmeddelanden.
null om värdet aldrig angetts.Anteckningar om beteende
- En tom array returneras både när ingen profil matchar e-postadressen och när en träff finns utanför din åtkomstkontext. Det här är avsiktligt — det hindrar slutpunkten från att läcka att det finns profiler du inte kan läsa.
- Nyskapade profiler går att hitta direkt via
emaileftersom flödet för att skapa profiler värmer cachen synkront. - Den ofiltrerade listan sorteras efter
created_atfallande (nyast först) och pagineras vialimitochoffset.
Upprepade anrop
Aniva lagrar svaret från den här slutpunkten i 5 minuter per API-nyckel. Ett upprepat anrop inom den tiden får det lagrade svaret. HeadernaCache-Status och Age visar att svaret är
lagrat och hur gammalt det är.
För att få veta om en ändring direkt kan du prenumerera på webhook-händelserna profile.created, profile.updated och profile.deleted.
Se Upprepade läsningar.
Felsvar
| Status | Beskrivning |
|---|---|
400 | Valideringsfel — ogiltigt e-postformat, eller limit/offset utanför giltigt intervall. |
403 | Förbjuden — din API-nyckel saknar nödvändigt scope (profiles_view/impersonate). |
500 | Internt serverfel. |
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"
}