Profiller
Profilleri listele
Hasta profillerini listele veya e-postaya göre ara
GET
/
api
/
v1
/
profiles
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
]
[]
{
"error": "email: Invalid email format"
}
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
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.Döndürülecek en fazla profil sayısı. Varsayılan 100, en fazla 500.
email ayarlandığında yok sayılır.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 birlikte200 OK döndürür.
Her öğenin yapısı Profili al ile eşleşir.
ISO/IEC 5218’e göre biyolojik cinsiyet (
0 = bilinmiyor, 1 = erkek, 2 = kadın). null olabilir.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.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
emailile hemen bulunabilir. - Filtrelenmemiş liste
created_atalanına göre azalan sırada (en yeni önce) sıralanır velimitileoffsetü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ı
| Durum | Açıklama |
|---|---|
400 | Doğrulama hatası — geçersiz e-posta biçimi veya aralık dışında limit/offset. |
403 | Erişim reddedildi — API anahtarın gerekli kapsama (profiles_view/impersonate) sahip değil. |
500 | Dahili sunucu hatası. |
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
]
[]
{
"error": "email: Invalid email format"
}
⌘I
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
]
[]
{
"error": "email: Invalid email format"
}