Profielen
Profielen weergeven
Patiëntprofielen weergeven of opzoeken op e-mailadres
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"
}
Geef patiëntprofielen weer waar je API-sleutel toegang toe heeft, of zoek er een op via het exacte e-mailadres.
Wanneer
email wordt meegegeven, voert het endpoint een in Redis gecachete exacte zoekopdracht uit op het
canonieke inlog-e-mailadres en geeft 0 of 1 resultaat terug; limit en offset worden in dat geval
genegeerd. Wanneer dit wordt weggelaten, geeft het endpoint een gepagineerde lijst met profielen terug binnen de
toegangscontext van je API-sleutel.
E-mailmatching is niet hoofdlettergevoelig en exact — substring- en prefixmatches worden niet ondersteund.
Alleen het canonieke inlog-e-mailadres wordt gecontroleerd; alternatieve adressen zoals work_email worden niet
meegenomen.
Vereist de scope profiles_view of impersonate.
Verzoek
Queryparameters
Filter op exact e-mailadres (niet hoofdlettergevoelig). Indien ingesteld, geeft dit 0 of 1 resultaat terug en
worden
limit/offset genegeerd. De zoekopdracht loopt via een in Redis gecachete reverse index, met een
geïndexeerde SQL-fallback.Maximumaantal profielen om terug te geven. Standaard 100, maximaal 500. Wordt genegeerd wanneer
email is ingesteld.Aantal profielen om over te slaan voor paginering. Standaard 0. Wordt genegeerd wanneer
email is ingesteld.Respons
Bij succes geeft de API200 OK terug met een array van profielobjecten. De structuur van elk
item komt overeen met Profiel ophalen.
Voorkeurstaal:
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 of uk.Of dit profiel transactionele (programmatische) e-mails ontvangt.
null als dit nooit is ingesteld.Opmerkingen over het gedrag
- Er wordt een lege array teruggegeven, zowel wanneer geen enkel profiel overeenkomt met het e-mailadres als wanneer er een match bestaat buiten je toegangscontext. Dit is bewust gedaan — zo voorkomt het endpoint dat het bestaan uitlekt van profielen die je niet kunt lezen.
- Nieuw aangemaakte profielen zijn direct vindbaar via
email, omdat de aanmaakflow de cache synchroon opwarmt. - De ongefilterde lijst wordt aflopend gesorteerd op
created_at(nieuwste eerst) en gepagineerd vialimitenoffset.
Herhaalde aanroepen
Aniva slaat het antwoord van dit endpoint 5 minuten op per API-sleutel. Een herhaalde aanroep binnen deze tijd krijgt het opgeslagen antwoord. De headersCache-Status en Age laten zien dat het antwoord is
opgeslagen en hoe oud het is.
Om direct op de hoogte te zijn van een wijziging, abonneer je je op de webhook-events profile.created, profile.updated en profile.deleted.
Zie Herhaalde leesverzoeken.
Foutresponsen
| Status | Beschrijving |
|---|---|
400 | Validatiefout — ongeldig e-mailformaat, of limit/offset buiten bereik. |
403 | Geen toegang — je API-sleutel heeft niet de vereiste scope (profiles_view/impersonate). |
500 | Interne serverfout. |
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"
}