Profiler
Vis profiler
Vis eller slå patientprofiler op ud fra 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"
}
Vis patientprofiler, som din API-nøgle har adgang til, eller slå en op på eksakt e-mailadresse.
Når
email angives, foretager endpointet et Redis-cachet eksakt opslag mod den
kanoniske login-e-mail og returnerer 0 eller 1 resultat; limit og offset ignoreres i det
tilfælde. Når den udelades, returnerer endpointet en pagineret liste over profiler begrænset til din
API-nøgles adgangskontekst.
E-mailmatch skelner ikke mellem store og små bogstaver og er eksakt — delstrengs- og præfiksmatch understøttes ikke.
Kun den kanoniske login-e-mail kontrolleres; alternative adresser som work_email tages ikke
i betragtning.
Kræver scopet profiles_view eller impersonate.
Forespørgsel
Forespørgselsparametre
Filtrer efter eksakt e-mailadresse (skelner ikke mellem store og små bogstaver). Når den er angivet, returneres 0 eller 1 resultat, og
limit/offset ignoreres. Opslaget betjenes af et Redis-cachet omvendt indeks med et
indekseret SQL-fallback.Maksimalt antal profiler, der skal returneres. Standard er 100, maksimum 500. Ignoreres, når
email er angivet.Antal profiler, der skal springes over ved paginering. Standard er 0. Ignoreres, når
email er angivet.Svar
Ved succes returnerer API’et200 OK med et array af profilobjekter. Strukturen for hvert
element svarer til Hent profil.
Foretrukket sprog:
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 denne profil modtager transaktionelle (automatiske) e-mails.
null, hvis den aldrig er angivet.Bemærkninger om adfærd
- Et tomt array returneres både, når ingen profil matcher e-mailen, og når der findes et match uden for din adgangskontekst. Det er tilsigtet — det forhindrer endpointet i at afsløre, at der findes profiler, du ikke kan læse.
- Nyoprettede profiler kan findes med det samme via
email, fordi oprettelsesflowet opdaterer cachen synkront. - Den ufiltrerede liste sorteres efter
created_atfaldende (nyeste først) og pagineres vialimitogoffset.
Gentagne kald
Aniva gemmer svaret fra dette endpoint i 5 minutter for hver API-nøgle. Et gentaget kald inden for dette tidsrum får det gemte svar. HeaderneCache-Status og Age viser, at svaret er
gemt, og hvor gammelt det er.
Hvis du vil have besked om en ændring med det samme, kan du abonnere på webhook-hændelserne profile.created, profile.updated og profile.deleted.
Se Gentagne læsninger.
Fejlsvar
| Status | Beskrivelse |
|---|---|
400 | Valideringsfejl — ugyldigt e-mailformat, eller limit/offset er uden for intervallet. |
403 | Forbudt — din API-nøgle har ikke det påkrævede scope (profiles_view/impersonate). |
500 | Intern serverfejl. |
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"
}