Ana içeriğe atla
GET
API anahtarının erişebildiği hasta profillerini listele veya tam e-posta adresiyle bir profil ara. email verildiğinde uç nokta, asıl oturum açma e-postası üzerinde Redis önbellekli tam eşleşme araması yapar ve 0 veya 1 sonuç döndürür; bu durumda limit ve offset yok sayılır. Verilmediğinde ise uç nokta, API anahtarının erişim bağlamına göre sayfalanmış bir profil listesi döndürür. E-posta eşleştirmesi büyük/küçük harfe duyarsız ve tamdır — alt dize ve ön ek eşleştirmeleri desteklenmez. Yalnızca asıl oturum açma e-postası kontrol edilir; work_email gibi alternatif adresler dikkate alınmaz. profiles_view veya impersonate kapsamı gerekir.

İstek

Sorgu parametreleri

string
Tam e-posta adresine göre filtrele (büyük/küçük harfe duyarsız). Ayarlandığında 0 veya 1 sonuç döndürür ve limit/offset yok sayılır. Arama, dizinlenmiş SQL yedekli bir Redis önbellekli ters dizin üzerinden yapılır.
integer
varsayılan:"100"
Döndürülecek en fazla profil sayısı. Varsayılan 100, en fazla 500. email ayarlandığında yok sayılır.
integer
varsayılan:"0"
Sayfalama için atlanacak profil sayısı. Varsayılan 0. email ayarlandığında yok sayılır.

Yanıt

İşlem başarılı olursa API, profil nesnelerinden oluşan bir diziyle birlikte 200 OK döndürür. Her öğenin yapısı Profili al ile eşleşir.
string
gerekli
Benzersiz profil kimliği (UUID).
string
Profil tanıtıcısı veya kullanıcı adı. null olabilir.
string
Ad. null olabilir.
string
Soyad. null olabilir.
string
E-posta adresi. null olabilir.
string
E.164 biçiminde telefon numarası. null olabilir.
integer
ISO/IEC 5218’e göre biyolojik cinsiyet (0 = bilinmiyor, 1 = erkek, 2 = kadın). null olabilir.
string
YYYY-MM-DD biçiminde doğum tarihi. null olabilir.
number
Santimetre cinsinden boy. null olabilir.
number
Kilogram cinsinden kilo. null olabilir.
string
Tercih edilen dil: 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 veya uk.
boolean
Bu profilin işlemsel (programatik) e-postaları alıp almayacağı. Hiç ayarlanmadığında null.
string
Profilin oluşturulduğu zamanın ISO 8601 zaman damgası.
string
Son güncellemenin ISO 8601 zaman damgası. null olabilir.

Davranış notları

  • Hem e-postayla eşleşen profil olmadığında hem de erişim bağlamının dışında bir eşleşme olduğunda boş bir dizi döndürülür. Bu kasıtlıdır — uç noktanın okuyamadığın profillerin varlığını sızdırmasını önler.
  • Oluşturma akışı önbelleği eşzamanlı olarak doldurduğundan, yeni oluşturulan profiller email ile hemen bulunabilir.
  • Filtrelenmemiş liste created_at alanına göre azalan sırada (en yeni önce) sıralanır ve limit ile offset üzerinden sayfalanır.

Tekrarlanan çağrılar

Aniva bu uç noktanın yanıtını her API anahtarı için 5 dakika boyunca saklar. Bu süre içinde yapılan yinelenen bir çağrı saklanan yanıtı alır. Cache-Status ve Age başlıkları yanıtın saklandığını ve ne kadar eski olduğunu gösterir. Bir değişiklikten anında haberdar olmak için profile.created, profile.updated ve profile.deleted webhook olaylarına abone ol. Tekrarlanan okumalar bölümüne bak.

Hata yanıtları