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

string
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.
integer
predeterminat:"100"
Nombre màxim de perfils que es retornen. Per defecte és 100, màxim 500. S’ignora quan s’especifica email.
integer
predeterminat:"0"
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 retorna 200 OK amb una matriu d’objectes de perfil. L’estructura de cada entrada coincideix amb Obtén el perfil.
string
requerit
Identificador únic del perfil (UUID).
string
Àlies del perfil o nom d’usuari. Pot ser null.
string
Nom. Pot ser null.
string
Cognom. Pot ser null.
string
Adreça electrònica. Pot ser null.
string
Número de telèfon en format E.164. Pot ser null.
integer
Sexe biològic segons la norma ISO/IEC 5218 (0 = desconegut, 1 = masculí, 2 = femení). Pot ser null.
string
Data de naixement en format YYYY-MM-DD. Pot ser null.
number
Alçada en centímetres. Pot ser null.
number
Pes en quilograms. Pot ser null.
string
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.
boolean
Indica si aquest perfil rep correus electrònics transaccionals (programàtics). És null si no s’ha definit mai.
string
Marca de temps ISO 8601 de quan es va crear el perfil.
string
Marca de temps ISO 8601 de l’última actualització. Pot ser null.

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 email perquè el flux de creació precarrega la memòria cau de manera síncrona.
  • La llista sense filtrar s’ordena per created_at en ordre descendent (els més recents primer) i es pagina mitjançant limit i offset.

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çaleres Cache-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