> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lister les profils

> Lister ou rechercher des profils de patients par e-mail

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

**email** `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é.

**limit** `integer` (default: 100)

Nombre maximal de profils à renvoyer. 100 par défaut, 500 au maximum. Ignoré lorsque `email` est défini.

**offset** `integer` (default: 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](https://docs.anivahealth.com/fr/api/profiles/get-profile.md).

**id** `string` *required*

Identifiant unique du profil (UUID).

**handle** `string`

Pseudonyme ou nom d'utilisateur du profil. Peut être `null`.

**first\_name** `string`

Prénom. Peut être `null`.

**last\_name** `string`

Nom de famille. Peut être `null`.

**email** `string`

Adresse e-mail. Peut être `null`.

**phone** `string`

Numéro de téléphone au format E.164. Peut être `null`.

**sex** `integer`

Sexe biologique selon la norme ISO/IEC 5218 (`0` = inconnu, `1` = masculin, `2` = féminin). Peut être `null`.

**date\_of\_birth** `string`

Date de naissance au format `YYYY-MM-DD`. Peut être `null`.

**height** `number`

Taille en centimètres. Peut être `null`.

**weight** `number`

Poids en kilogrammes. Peut être `null`.

**language** `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`.

**transactional\_emails\_enabled** `boolean`

Indique si ce profil reçoit des e-mails transactionnels (automatiques). `null` si jamais défini.

**created\_at** `string`

Horodatage ISO 8601 de création du profil.

**updated\_at** `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](https://docs.anivahealth.com/fr/concepts/webhooks.md#lectures-repetees).

## 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. |

```bash cURL (lookup by email) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (paginated list) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
[
  {
    "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"
  }
]
```

```json 200 (no match) theme={null}
[]
```

```json 400 theme={null}
{
  "error": "email: Invalid email format"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.