Перейти к основному содержанию
GET
Получи список профилей пациентов, доступных твоему API-ключу, или найди профиль по точному адресу электронной почты. Если передать email, эндпоинт выполняет поиск точного совпадения по основному адресу электронной почты для входа с кэшированием в Redis и возвращает 0 или 1 результат; limit и offset в этом случае игнорируются. Если параметр не передан, эндпоинт возвращает список профилей с пагинацией в рамках контекста доступа твоего API-ключа. Поиск по адресу электронной почты нечувствителен к регистру и требует точного совпадения — поиск по подстроке и префиксу не поддерживается. Проверяется только основной адрес для входа; дополнительные адреса вроде work_email не учитываются. Требуется область доступа profiles_view или impersonate.

Запрос

Параметры запроса

string
Фильтр по точному адресу электронной почты (без учёта регистра). Если задан, возвращает 0 или 1 результат, а limit/offset игнорируются. Поиск выполняется по обратному индексу с кэшированием в Redis и резервным индексированным SQL-запросом.
integer
по умолчанию:"100"
Максимальное количество возвращаемых профилей. По умолчанию 100, максимум 500. Игнорируется, если задан email.
integer
по умолчанию:"0"
Количество профилей, которые нужно пропустить для пагинации. По умолчанию 0. Игнорируется, если задан email.

Ответ

При успехе API возвращает 200 OK с массивом объектов профилей. Структура каждого элемента соответствует Получению профиля.
string
обязательно
Уникальный идентификатор профиля (UUID).
string
Хендл или имя пользователя профиля. Может быть null.
string
Имя. Может быть null.
string
Фамилия. Может быть null.
string
Адрес электронной почты. Может быть null.
string
Номер телефона в формате E.164. Может быть null.
integer
Биологический пол по ISO/IEC 5218 (0 = неизвестно, 1 = мужской, 2 = женский). Может быть null.
string
Дата рождения в формате YYYY-MM-DD. Может быть null.
number
Рост в сантиметрах. Может быть null.
number
Вес в килограммах. Может быть null.
string
Предпочитаемый язык: 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.
boolean
Получает ли этот профиль транзакционные (автоматические) письма. null, если значение не задавалось.
string
Временная метка создания профиля в формате ISO 8601.
string
Временная метка последнего обновления в формате ISO 8601. Может быть null.

Особенности работы

  • Пустой массив возвращается и когда ни один профиль не совпадает с адресом электронной почты, и когда совпадение есть вне твоего контекста доступа. Это сделано намеренно, чтобы эндпоинт не раскрывал существование профилей, которые ты не можешь читать.
  • Только что созданные профили сразу находятся по email, потому что процесс создания синхронно прогревает кэш.
  • Список без фильтров отсортирован по created_at по убыванию (сначала новые) и разбивается на страницы через limit и offset.

Повторные вызовы

Aniva хранит ответ этого эндпоинта 5 минут для каждого API-ключа. Повторный запрос в течение этого времени получает сохранённый ответ. Заголовки Cache-Status и Age показывают, что ответ сохранён, и как давно он получен. Чтобы сразу узнавать об изменениях, подпишись на события вебхуков profile.created, profile.updated и profile.deleted. См. Повторные чтения.

Ответы с ошибками