Профили
Получить список профилей
Получить список профилей пациентов или найти их по адресу электронной почты
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 с массивом объектов профилей. Структура каждого
элемента соответствует Получению профиля.
Биологический пол по ISO/IEC 5218 (
0 = неизвестно, 1 = мужской, 2 = женский). Может быть null.Предпочитаемый язык:
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"
}