Profiler
List opp profiler
List opp eller søk opp pasientprofiler etter 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"
}
List opp pasientprofiler som API-nøkkelen din har tilgang til, eller slå opp én etter eksakt e-postadresse.
Når
email oppgis, gjør endepunktet et Redis-bufret eksakt oppslag mot den
kanoniske innloggings-e-postadressen og returnerer 0 eller 1 treff; limit og offset ignoreres i så
fall. Når parameteren utelates, returnerer endepunktet en paginert liste over profiler avgrenset til
tilgangskonteksten til API-nøkkelen din.
Samsvar på e-post skiller ikke mellom store og små bokstaver og må være eksakt – delstreng- og prefikstreff støttes ikke.
Kun den kanoniske innloggings-e-postadressen sjekkes; alternative adresser som work_email blir ikke
vurdert.
Krever tilgangsomfanget profiles_view eller impersonate.
Forespørsel
Spørreparametere
Filtrer etter eksakt e-postadresse (skiller ikke mellom store og små bokstaver). Når den er angitt, returneres 0 eller 1 treff, og
limit/offset ignoreres. Oppslaget betjenes av en Redis-bufret omvendt indeks, med
indeksert SQL som reserveløsning.Maksimalt antall profiler som returneres. Standard er 100, maks 500. Ignoreres når
email er angitt.Antall profiler som skal hoppes over ved paginering. Standard er 0. Ignoreres når
email er angitt.Respons
Ved suksess returnerer API-et200 OK med en liste med profilobjekter. Strukturen til hvert
element samsvarer med Hent profil.
Foretrukket 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 denne profilen mottar transaksjonelle (programmatiske) e-poster.
null når verdien aldri er satt.Merknader om virkemåte
- En tom liste returneres både når ingen profil samsvarer med e-postadressen, og når et treff finnes utenfor tilgangskonteksten din. Dette er tilsiktet – det hindrer endepunktet i å lekke eksistensen av profiler du ikke har lesetilgang til.
- Nyopprettede profiler kan umiddelbart finnes via
emailfordi opprettelsesflyten varmer opp hurtigbufferen synkront. - Den ufiltrerte listen sorteres etter
created_atsynkende (nyeste først) og pagineres medlimitogoffset.
Gjentatte kall
Aniva lagrer svaret fra dette endepunktet i 5 minutter for hver API-nøkkel. Et gjentatt kall innenfor denne tiden får det lagrede svaret. HeaderneCache-Status og Age viser at svaret er
lagret og hvor gammelt det er.
For å få beskjed om en endring med en gang kan du abonnere på webhook-hendelsene profile.created, profile.updated og profile.deleted.
Se Gjentatte lesinger.
Feilresponser
| Status | Beskrivelse |
|---|---|
400 | Valideringsfeil – ugyldig e-postformat, eller limit/offset utenfor gyldig område. |
403 | Ingen tilgang – API-nøkkelen din mangler påkrevd tilgangsomfang (profiles_view/impersonate). |
500 | Intern serverfeil. |
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"
}