Vai al contenuto principale
GET
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

string
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.
integer
predefinito:"100"
Numero massimo di profili da restituire. Valore predefinito 100, massimo 500. Ignorato quando email è impostato.
integer
predefinito:"0"
Numero di profili da saltare per la paginazione. Valore predefinito 0. Ignorato quando email è impostato.

Risposta

In caso di successo, l’API restituisce 200 OK con un array di oggetti profilo. La struttura di ogni elemento corrisponde a Ottieni profilo.
string
obbligatorio
Identificativo univoco del profilo (UUID).
string
Handle o nome utente del profilo. Può essere null.
string
Nome. Può essere null.
string
Cognome. Può essere null.
string
Indirizzo email. Può essere null.
string
Numero di telefono in formato E.164. Può essere null.
integer
Sesso biologico secondo ISO/IEC 5218 (0 = sconosciuto, 1 = maschio, 2 = femmina). Può essere null.
string
Data di nascita in formato YYYY-MM-DD. Può essere null.
number
Altezza in centimetri. Può essere null.
number
Peso in chilogrammi. Può essere null.
string
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.
boolean
Indica se questo profilo riceve email transazionali (programmatiche). null se non è mai stato impostato.
string
Timestamp ISO 8601 della creazione del profilo.
string
Timestamp ISO 8601 dell’ultimo aggiornamento. Può essere null.

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 email perché il flusso di creazione popola la cache in modo sincrono.
  • L’elenco non filtrato è ordinato per created_at decrescente (i più recenti prima) e paginato tramite limit e offset.

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