Profili
Elenca profili
Elenca o cerca i profili paziente per email
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"
}
Elenca i profili paziente accessibili alla tua chiave API o cercane uno per indirizzo email esatto.
Quando
email è fornito, l’endpoint esegue una ricerca esatta con cache Redis sull’email
canonica di accesso e restituisce 0 o 1 risultato; in quel caso limit e offset vengono
ignorati. Quando è omesso, l’endpoint restituisce un elenco paginato di profili limitato al
contesto di accesso della tua chiave API.
La corrispondenza dell’email è esatta e non distingue tra maiuscole e minuscole — le ricerche per
sottostringa o prefisso non sono supportate. Viene controllata solo l’email canonica di accesso;
indirizzi alternativi come work_email non vengono considerati.
Richiede lo scope profiles_view o impersonate.
Richiesta
Parametri di query
Filtra per indirizzo email esatto (senza distinzione tra maiuscole e minuscole). Quando è impostato,
restituisce 0 o 1 risultato e
limit/offset vengono ignorati. La ricerca è servita da un indice
inverso in cache Redis, con fallback SQL indicizzato.Numero massimo di profili da restituire. Valore predefinito 100, massimo 500. Ignorato quando
email è impostato.Numero di profili da saltare per la paginazione. Valore predefinito 0. Ignorato quando
email è impostato.Risposta
In caso di successo, l’API restituisce200 OK con un array di oggetti profilo. La struttura di ogni
elemento corrisponde a Ottieni profilo.
Sesso biologico secondo ISO/IEC 5218 (
0 = sconosciuto, 1 = maschio, 2 = femmina). Può essere null.Lingua preferita:
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 o uk.Indica se questo profilo riceve email transazionali (programmatiche).
null se non è mai stato impostato.Note sul comportamento
- Viene restituito un array vuoto sia quando nessun profilo corrisponde all’email, sia quando esiste una corrispondenza fuori dal tuo contesto di accesso. È intenzionale — evita che l’endpoint riveli l’esistenza di profili che non puoi leggere.
- I profili appena creati sono immediatamente trovabili tramite
emailperché il flusso di creazione popola la cache in modo sincrono. - L’elenco non filtrato è ordinato per
created_atdecrescente (i più recenti prima) e paginato tramitelimiteoffset.
Chiamate ripetute
Aniva salva la risposta di questo endpoint per 5 minuti per ogni chiave API. Una chiamata ripetuta in questo intervallo riceve la risposta salvata. Gli headerCache-Status e Age indicano che la risposta è
salvata e da quanto tempo.
Per sapere subito di una modifica, iscriviti agli eventi webhook profile.created, profile.updated e profile.deleted.
Vedi Letture ripetute.
Risposte di errore
| Stato | Descrizione |
|---|---|
400 | Errore di validazione — formato email non valido, oppure limit/offset fuori intervallo. |
403 | Accesso negato — la tua chiave API non ha lo scope richiesto (profiles_view/impersonate). |
500 | Errore interno del server. |
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"
}