Passer au contenu principal
GET
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

string
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é.
integer
défaut:"100"
Nombre maximal de profils à renvoyer. 100 par défaut, 500 au maximum. Ignoré lorsque email est défini.
integer
défaut:"0"
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 renvoie 200 OK avec un tableau d’objets profil. La structure de chaque entrée correspond à Récupérer un profil.
string
requis
Identifiant unique du profil (UUID).
string
Pseudonyme ou nom d’utilisateur du profil. Peut être null.
string
Prénom. Peut être null.
string
Nom de famille. Peut être null.
string
Adresse e-mail. Peut être null.
string
Numéro de téléphone au format E.164. Peut être null.
integer
Sexe biologique selon la norme ISO/IEC 5218 (0 = inconnu, 1 = masculin, 2 = féminin). Peut être null.
string
Date de naissance au format YYYY-MM-DD. Peut être null.
number
Taille en centimètres. Peut être null.
number
Poids en kilogrammes. Peut être null.
string
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.
boolean
Indique si ce profil reçoit des e-mails transactionnels (automatiques). null si jamais défini.
string
Horodatage ISO 8601 de création du profil.
string
Horodatage ISO 8601 de la dernière mise à jour. Peut être null.

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_at décroissant (du plus récent au plus ancien) et paginée via limit et offset.

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êtes Cache-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