Perfils
Llista els perfils
Llista o cerca perfils de pacients per correu electrònic
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"
}
Llista els perfils de pacients accessibles per a la teva clau API o cerca’n un per adreça electrònica exacta.
Quan es proporciona
email, l’endpoint fa una cerca de coincidència exacta emmagatzemada en memòria cau a Redis sobre l’adreça
electrònica canònica d’inici de sessió i retorna 0 o 1 resultat; en aquest cas s’ignoren limit i
offset. Si s’omet, l’endpoint retorna una llista paginada de perfils dins del context
d’accés de la teva clau API.
La coincidència d’adreça electrònica no distingeix entre majúscules i minúscules i és exacta — no s’admeten coincidències de subcadenes ni de prefixos.
Només es comprova l’adreça electrònica canònica d’inici de sessió; no es tenen en compte adreces alternatives com
work_email.
Requereix l’àmbit profiles_view o impersonate.
Sol·licitud
Paràmetres de consulta
Filtra per adreça electrònica exacta (sense distingir majúscules i minúscules). Si s’especifica, retorna 0 o 1 resultat i
s’ignoren
limit/offset. La cerca es fa mitjançant un índex invers emmagatzemat en memòria cau a Redis, amb un
mecanisme alternatiu en SQL indexat.Nombre màxim de perfils que es retornen. Per defecte és 100, màxim 500. S’ignora quan s’especifica
email.Nombre de perfils que s’ometen per a la paginació. Per defecte és 0. S’ignora quan s’especifica
email.Resposta
En cas d’èxit, l’API retorna200 OK amb una matriu d’objectes de perfil. L’estructura de cada
entrada coincideix amb Obtén el perfil.
Sexe biològic segons la norma ISO/IEC 5218 (
0 = desconegut, 1 = masculí, 2 = femení). Pot ser null.Idioma preferit:
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 si aquest perfil rep correus electrònics transaccionals (programàtics). És
null si no s’ha definit mai.Notes de comportament
- Es retorna una matriu buida tant quan cap perfil coincideix amb l’adreça electrònica com quan hi ha una coincidència fora del teu context d’accés. Això és intencionat — evita que l’endpoint reveli l’existència de perfils que no pots llegir.
- Els perfils acabats de crear es poden trobar immediatament per
emailperquè el flux de creació precarrega la memòria cau de manera síncrona. - La llista sense filtrar s’ordena per
created_aten ordre descendent (els més recents primer) i es pagina mitjançantlimitioffset.
Crides repetides
Aniva desa la resposta d’aquest punt final durant 5 minuts per a cada clau d’API. Una crida repetida dins d’aquest període rep la resposta desada. Les capçaleresCache-Status i Age indiquen que la resposta està
desada i quina antiguitat té.
Per assabentar-te d’un canvi a l’instant, subscriu-te als esdeveniments de webhook profile.created, profile.updated i profile.deleted.
Consulta Lectures repetides.
Respostes d’error
| Estat | Descripció |
|---|---|
400 | Error de validació — format d’adreça electrònica no vàlid, o limit/offset fora d’interval. |
403 | Prohibit — la teva clau API no té l’àmbit necessari (profiles_view/impersonate). |
500 | Error intern del servidor. |
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"
}