Перейти до основного вмісту
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. Див. Повторні зчитування.

Відповіді з помилками