Perfiles
Listar perfiles
Listar o buscar perfiles de pacientes por correo electrónico
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"
}
Lista los perfiles de pacientes accesibles para tu clave de API o busca uno por su dirección de correo electrónico exacta.
Cuando se proporciona
email, el endpoint realiza una búsqueda exacta en caché de Redis sobre el
correo electrónico canónico de inicio de sesión y devuelve 0 o 1 resultado; en ese caso se ignoran limit y offset.
Cuando se omite, el endpoint devuelve una lista paginada de perfiles limitada al contexto de acceso de tu
clave de API.
La coincidencia de correo electrónico es exacta y no distingue entre mayúsculas y minúsculas; no se admiten coincidencias parciales ni por prefijo.
Solo se comprueba el correo electrónico canónico de inicio de sesión; no se tienen en cuenta direcciones alternativas como work_email.
Requiere el ámbito profiles_view o impersonate.
Solicitud
Parámetros de consulta
Filtra por dirección de correo electrónico exacta (sin distinguir entre mayúsculas y minúsculas). Si se indica, devuelve 0 o 1 resultado y
se ignoran
limit/offset. La búsqueda se atiende mediante un índice inverso en caché de Redis, con
respaldo SQL indexado.Número máximo de perfiles que se devolverán. Por defecto es 100, máximo 500. Se ignora si se indica
email.Número de perfiles que se omiten para la paginación. Por defecto es 0. Se ignora si se indica
email.Respuesta
Si tiene éxito, la API devuelve200 OK con un array de objetos de perfil. La estructura de cada
elemento coincide con Obtener perfil.
Sexo biológico según ISO/IEC 5218 (
0 = desconocido, 1 = masculino, 2 = femenino). Puede ser null.Idioma preferido:
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 este perfil recibe correos electrónicos transaccionales (programáticos).
null si nunca se ha configurado.Notas de comportamiento
- Se devuelve un array vacío tanto cuando ningún perfil coincide con el correo electrónico como cuando existe una coincidencia fuera de tu contexto de acceso. Esto es intencionado: evita que el endpoint revele la existencia de perfiles que no puedes leer.
- Los perfiles recién creados se pueden encontrar de inmediato por
emailporque el flujo de creación precarga la caché de forma síncrona. - La lista sin filtrar se ordena por
created_atde forma descendente (los más recientes primero) y se pagina mediantelimityoffset.
Llamadas repetidas
Aniva almacena la respuesta de este endpoint durante 5 minutos para cada clave de API. Una llamada repetida dentro de este plazo obtiene la respuesta almacenada. Las cabecerasCache-Status y Age indican que la respuesta está
almacenada y cuál es su antigüedad.
Para enterarte de un cambio al instante, suscríbete a los eventos de webhook profile.created, profile.updated y profile.deleted.
Consulta Lecturas repetidas.
Respuestas de error
| Estado | Descripción |
|---|---|
400 | Error de validación: formato de correo electrónico no válido o limit/offset fuera de rango. |
403 | Prohibido: tu clave de API no tiene el ámbito necesario (profiles_view/impersonate). |
500 | Error interno 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"
}