Профілі
Список профілів
Отримати список профілів пацієнтів або знайти їх за електронною поштою
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-ключу, або знайди один із них за точною електронною адресою.
Якщо передано
email, ендпоїнт виконує кешований у Redis пошук за точним збігом із
канонічною електронною адресою для входу та повертає 0 або 1 результат; у такому разі limit і offset
ігноруються. Якщо параметр не передано, ендпоїнт повертає список профілів із пагінацією в межах контексту доступу твого
API-ключа.
Пошук за електронною адресою є точним і нечутливим до регістру — пошук за підрядком і префіксом не підтримується.
Перевіряється лише канонічна електронна адреса для входу; альтернативні адреси, як-от work_email, не
враховуються.
Потребує дозволу profiles_view або impersonate.
Запит
Параметри запиту
Фільтр за точною електронною адресою (без урахування регістру). Якщо задано, повертає 0 або 1 результат, а
limit/offset ігноруються. Пошук обслуговується зворотним індексом із кешуванням у Redis та
індексованим резервним запитом SQL.Максимальна кількість профілів у відповіді. За замовчуванням 100, максимум 500. Ігнорується, якщо задано
email.Кількість профілів, які потрібно пропустити для пагінації. За замовчуванням 0. Ігнорується, якщо задано
email.Відповідь
У разі успіху API повертає200 OK із масивом об’єктів профілів. Структура кожного
елемента відповідає Отримати профіль.
Бажана мова:
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 або uk.Чи отримує цей профіль транзакційні (програмні) листи.
null, якщо значення ніколи не встановлювалося.Особливості роботи
- Порожній масив повертається і тоді, коли жоден профіль не відповідає електронній адресі, і тоді, коли збіг існує поза межами твого контексту доступу. Це зроблено навмисно — так ендпоїнт не розкриває існування профілів, які ти не можеш читати.
- Щойно створені профілі одразу можна знайти за
email, оскільки процес створення синхронно прогріває кеш. - Нефільтрований список відсортовано за
created_atу порядку спадання (спочатку найновіші) з пагінацією черезlimitіoffset.
Повторні виклики
Aniva зберігає відповідь цього ендпойнта 5 хвилин для кожного API-ключа. Повторний виклик упродовж цього часу отримує збережену відповідь. ЗаголовкиCache-Status і Age показують, що відповідь
збережена і як давно її збережено.
Щоб дізнаватися про зміни одразу, підпишись на події вебхуків profile.created, profile.updated та profile.deleted.
Див. Повторні зчитування.
Відповіді з помилками
| Статус | Опис |
|---|---|
400 | Помилка валідації — некоректний формат електронної адреси або значення limit/offset поза допустимим діапазоном. |
403 | Доступ заборонено — твій API-ключ не має потрібного дозволу (profiles_view/impersonate). |
500 | Внутрішня помилка сервера. |
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"
}