Salt la conținutul principal
GET
Listează profilurile de pacienți accesibile cheii tale API sau caută unul după adresa de e-mail exactă. Când email este furnizat, endpointul efectuează o căutare cu potrivire exactă din cache-ul Redis după adresa de e-mail canonică de autentificare și returnează 0 sau 1 rezultat; limit și offset sunt ignorate în acest caz. Când lipsește, endpointul returnează o listă paginată de profiluri limitată la contextul de acces al cheii tale API. Potrivirea adresei de e-mail nu ține cont de majuscule și este exactă — potrivirile parțiale sau după prefix nu sunt acceptate. Se verifică doar adresa de e-mail canonică de autentificare; adresele alternative, precum work_email, nu sunt luate în considerare. Necesită scope-ul profiles_view sau impersonate.

Cerere

Parametri de interogare

string
Filtrează după adresa de e-mail exactă (fără a ține cont de majuscule). Când este setat, returnează 0 sau 1 rezultat, iar limit/offset sunt ignorate. Căutarea folosește un index invers în cache Redis, cu fallback SQL indexat.
integer
implicit:"100"
Numărul maxim de profiluri de returnat. Valoare implicită 100, maxim 500. Ignorat când email este setat.
integer
implicit:"0"
Numărul de profiluri de omis pentru paginare. Valoare implicită 0. Ignorat când email este setat.

Răspuns

În caz de succes, API-ul returnează 200 OK împreună cu un array de obiecte de profil. Structura fiecărei intrări corespunde cu Obține profilul.
string
obligatoriu
Identificator unic al profilului (UUID).
string
Handle-ul profilului sau numele de utilizator. Poate fi null.
string
Prenume. Poate fi null.
string
Nume de familie. Poate fi null.
string
Adresă de e-mail. Poate fi null.
string
Număr de telefon în format E.164. Poate fi null.
integer
Sex biologic conform ISO/IEC 5218 (0 = necunoscut, 1 = masculin, 2 = feminin). Poate fi null.
string
Data nașterii în format YYYY-MM-DD. Poate fi null.
number
Înălțime în centimetri. Poate fi null.
number
Greutate în kilograme. Poate fi null.
string
Limba preferată: 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 sau uk.
boolean
Indică dacă acest profil primește e-mailuri tranzacționale (programatice). null dacă nu a fost setat niciodată.
string
Marcaj temporal ISO 8601 al creării profilului.
string
Timestamp ISO 8601 al ultimei actualizări. Poate fi null.

Note de comportament

  • Se returnează un array gol atât când niciun profil nu se potrivește cu adresa de e-mail, cât și când există o potrivire în afara contextului tău de acces. Acest lucru este intenționat — împiedică endpointul să dezvăluie existența profilurilor pe care nu le poți citi.
  • Profilurile nou create pot fi găsite imediat după email, deoarece fluxul de creare populează cache-ul sincron.
  • Lista nefiltrată este ordonată descrescător după created_at (cele mai noi primele) și paginată prin limit și offset.

Apeluri repetate

Aniva stochează răspunsul acestui endpoint timp de 5 minute pentru fiecare cheie API. Un apel repetat în acest interval primește răspunsul stocat. Antetele Cache-Status și Age arată că răspunsul este stocat și cât de vechi este. Pentru a afla imediat despre o modificare, abonează-te la evenimentele webhook profile.created, profile.updated și profile.deleted. Vezi Citiri repetate.

Răspunsuri de eroare