Profils
Lister les profils
Lister ou rechercher des profils de patients par 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"
}
Liste les profils patients accessibles à ta clé API ou recherche-en un par adresse e-mail exacte.
Lorsque
email est fourni, l’endpoint effectue une recherche de correspondance exacte mise en cache dans Redis sur
l’adresse e-mail de connexion canonique et renvoie 0 ou 1 résultat ; limit et offset sont alors
ignorés. Lorsqu’il est omis, l’endpoint renvoie une liste paginée des profils limités au contexte d’accès de ta
clé API.
La correspondance d’e-mail est exacte et insensible à la casse — les correspondances partielles et par préfixe ne sont pas prises en charge.
Seule l’adresse e-mail de connexion canonique est vérifiée ; les autres adresses comme work_email ne sont pas
prises en compte.
Nécessite le scope profiles_view ou impersonate.
Requête
Paramètres de requête
Filtrer par adresse e-mail exacte (insensible à la casse). Lorsqu’il est défini, renvoie 0 ou 1 résultat et
limit/offset sont ignorés. La recherche utilise un index inversé mis en cache dans Redis, avec un
repli sur SQL indexé.Nombre maximal de profils à renvoyer. 100 par défaut, 500 au maximum. Ignoré lorsque
email est défini.Nombre de profils à ignorer pour la pagination. 0 par défaut. Ignoré lorsque
email est défini.Réponse
En cas de succès, l’API renvoie200 OK avec un tableau d’objets profil. La structure de chaque
entrée correspond à Récupérer un profil.
Sexe biologique selon la norme ISO/IEC 5218 (
0 = inconnu, 1 = masculin, 2 = féminin). Peut être null.Langue préférée :
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 ou uk.Indique si ce profil reçoit des e-mails transactionnels (automatiques).
null si jamais défini.Notes de comportement
- Un tableau vide est renvoyé aussi bien lorsqu’aucun profil ne correspond à l’e-mail que lorsqu’une correspondance existe en dehors de ton contexte d’accès. C’est intentionnel — cela empêche l’endpoint de révéler l’existence de profils que tu ne peux pas lire.
- Les profils nouvellement créés sont immédiatement trouvables par
email, car le flux de création alimente le cache de manière synchrone. - La liste non filtrée est triée par
created_atdécroissant (du plus récent au plus ancien) et paginée vialimitetoffset.
Appels répétés
Aniva conserve la réponse de ce point de terminaison pendant 5 minutes pour chaque clé API. Un appel répété pendant ce délai reçoit la réponse conservée. Les en-têtesCache-Status et Age indiquent que la réponse est
conservée et depuis combien de temps.
Pour être informé immédiatement d’un changement, abonne-toi aux événements webhook profile.created, profile.updated et profile.deleted.
Voir Lectures répétées.
Réponses d’erreur
| Statut | Description |
|---|---|
400 | Erreur de validation — format d’e-mail invalide, ou limit/offset hors plage. |
403 | Accès refusé — ta clé API ne dispose pas du scope requis (profiles_view/impersonate). |
500 | Erreur interne du serveur. |
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"
}