Saltar al contenido principal
GET
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

string
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.
integer
predeterminado:"100"
Número máximo de perfiles que se devolverán. Por defecto es 100, máximo 500. Se ignora si se indica email.
integer
predeterminado:"0"
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 devuelve 200 OK con un array de objetos de perfil. La estructura de cada elemento coincide con Obtener perfil.
string
requerido
Identificador único del perfil (UUID).
string
Alias o nombre de usuario del perfil. Puede ser null.
string
Nombre. Puede ser null.
string
Apellidos. Puede ser null.
string
Dirección de correo electrónico. Puede ser null.
string
Número de teléfono en formato E.164. Puede ser null.
integer
Sexo biológico según ISO/IEC 5218 (0 = desconocido, 1 = masculino, 2 = femenino). Puede ser null.
string
Fecha de nacimiento en formato YYYY-MM-DD. Puede ser null.
number
Altura en centímetros. Puede ser null.
number
Peso en kilogramos. Puede ser null.
string
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.
boolean
Indica si este perfil recibe correos electrónicos transaccionales (programáticos). null si nunca se ha configurado.
string
Marca de tiempo ISO 8601 de creación del perfil.
string
Marca de tiempo ISO 8601 de la última actualización. Puede ser null.

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 email porque el flujo de creación precarga la caché de forma síncrona.
  • La lista sin filtrar se ordena por created_at de forma descendente (los más recientes primero) y se pagina mediante limit y offset.

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 cabeceras Cache-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