> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Отримати список записів

> Отримати записи на забір крові, доступні для твого API-ключа

Отримати список записів на забір крові. Кожен запис містить вбудований профіль пацієнта.

Фільтри поєднуються:

* `date` повертає записи за один календарний день. Це місцевий день локації кожного запису, тому забір крові о 23:30 у Берліні враховується за берлінською датою.
* `location_id` повертає записи в одній локації тестування.
* `profile_id` без `date` повертає всі записи для цього профілю без обмеження в часі.
* Без `profile_id` і без `date` діє часове вікно за замовчуванням: за останні 2 місяці та на 1 місяць наперед.

Потребує дозволу `appointments_view` або `appointments_schedule`.

## Запит

### Параметри запиту

**profile\_id** `string`

Фільтр за UUID профілю. Якщо вказано, повертаються всі записи для цього профілю незалежно
від запланованої дати. Якщо не вказано, діє часове вікно за замовчуванням.

**location\_id** `string`

Фільтр за UUID локації тестування.

**date** `string`

Календарний день у форматі `YYYY-MM-DD` у часовому поясі локації кожного запису. Замінює
часове вікно за замовчуванням. Результати відсортовано за `scheduled_at` від найраніших.

## Відповідь

У разі успіху API повертає `200 OK` із масивом об’єктів записів.

**id** `string` *required*

Унікальний ідентифікатор запису (UUID).

**profile\_id** `string` *required*

UUID профілю, до якого належить цей запис.

**location\_id** `string`

UUID локації тестування, де відбувається забір крові.

**scheduled\_at** `string`

Заплановані дата й час запису в UTC (ISO 8601 із суфіксом `Z`, наприклад
`2026-05-15T10:30:00Z`). Може бути `null`.

**status** `string` *required*

Поточний статус запису. Одне зі значень: `pending`, `confirmed`, `blood_drawn` або `cancelled`.
Детальний статус готовності результатів аналізів можна отримати з [Отримати результати](https://docs.anivahealth.com/uk/api/appointments/get-results.md),
а докладніший прогрес відправлення — із кожного елемента вбудованого масиву `shipments` (див. нижче)
із переходом до [Отримати відправлення](https://docs.anivahealth.com/uk/api/shipments/get-shipment.md).

**cancellation\_reason** `string`

Причина скасування у вільній формі, зафіксована під час скасування запису (наприклад, неявка, пізнє скасування,
«Помилка. Потрібно повторити»). `null`, якщо `status` не дорівнює `cancelled`.

**results\_ready\_emails** `string[]` *required*

Електронні адреси в нижньому регістрі, на кожну з яких надходить один лист, коли всі лабораторні результати стають остаточними. Порожньо, якщо вимкнено. Див.
[Листи про готовність результатів](https://docs.anivahealth.com/uk/concepts/results.md#listi-pro-gotovnist-rezultativ).

**draw\_method** `string` *required*

Спосіб забору крові: `capillary` (із пальця або плеча в мікротейнери) або `venous` (із вени
у пробірки). Це спосіб, указаний у записі, або `default_draw_method` його
[локації](https://docs.anivahealth.com/uk/concepts/locations.md). Після забору крові — це фактично використаний спосіб.

**created\_at** `string` *required*

Часова мітка ISO 8601 створення запису.

**updated\_at** `string`

Часова мітка ISO 8601 останнього оновлення. Може бути `null`.

**profile** `object` *required*

Профіль пацієнта, пов’язаний із цим записом.

**Профіль**

**id** `string`

Унікальний ідентифікатор профілю (UUID).

**handle** `string`

Нікнейм або ім’я користувача профілю. Може бути `null`.

**first\_name** `string`

Ім’я. Може бути `null`.

**last\_name** `string`

Прізвище. Може бути `null`.

**email** `string`

Електронна адреса. Може бути `null`.

**phone** `string`

Номер телефону у форматі E.164. Може бути `null`.

**sex** `integer`

Біологічна стать за стандартом ISO/IEC 5218. Може бути `null`.

**date\_of\_birth** `string`

Дата народження у форматі `YYYY-MM-DD`. Може бути `null`.

**height** `number`

Зріст у сантиметрах. Може бути `null`.

**weight** `number`

Вага в кілограмах. Може бути `null`.

**language** `string`

Бажана мова: один із 32 кодів у [Створити профіль](https://docs.anivahealth.com/uk/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Чи отримує цей профіль транзакційні (програмні) листи. Може бути `null`.

**created\_at** `string`

Часова мітка ISO 8601 створення профілю.

**updated\_at** `string`

Часова мітка ISO 8601 останнього оновлення профілю. Може бути `null`.

**panels** `AppointmentPanel[]` *required*

Панелі, які наразі прикріплені до цього запису. Скасовані прикріплення не включено. Переглянь деталі
панелі (назву, біомаркери) через [Список панелей](https://docs.anivahealth.com/uk/api/panels/list-panels.md).

**Поля доданої панелі**

**panel\_id** `string`

UUID панелі — звіряй зі [Списком панелей](https://docs.anivahealth.com/uk/api/panels/list-panels.md).

**added\_at** `string`

Часова мітка ISO 8601 першого додавання панелі до цього запису.

**individual\_biomarkers** `AppointmentIndividualBiomarker[]` *required*

Окремі біомаркери, додані до цього запису поза межами панелей (див. [Додати окремі
біомаркери](https://docs.anivahealth.com/uk/api/appointments/add-individual-biomarkers.md)). Звіряй кожен `biomarker_id`
зі [Списком біомаркерів](https://docs.anivahealth.com/uk/api/biomarkers/list-biomarkers.md), щоб отримати дані для відображення.

**Поля окремого біомаркера**

**biomarker\_id** `integer`

Ідентифікатор біомаркера — звіряй зі
[Списком біомаркерів](https://docs.anivahealth.com/uk/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

Часова мітка ISO 8601 першого додавання біомаркера до цього запису.

**shipments** `AppointmentShipmentLink[]` *required*

Відправлення, пов’язані з цим записом, у порядку прив’язування від найдавнішого. Порожній масив, якщо пов’язаних відправлень
немає. Перевір кожен `id` через [Отримати відправлення](https://docs.anivahealth.com/uk/api/shipments/get-shipment.md), щоб отримати
повні дані відправлення (статус, трек-номер, оновлення статусу тощо).

**Поля прив’язки відправлення**

**id** `string`

Ідентифікатор посилання на відправлення — звіряй через
[Отримати відправлення](https://docs.anivahealth.com/uk/api/shipments/get-shipment.md).

**added\_at** `string`

Часова мітка ISO 8601 першої прив’язки відправлення до цього запису.

**lab\_codes** `string[]` *required*

Лабораторні коди (штрихкоди пробірок), зафіксовані для цього запису, у порядку сканування. Порожньо до підтвердження
забору крові. Венозний забір крові має один код, надрукований на кожній пробірці; капілярний забір крові має по одному
коду на кожен мікротейнер. Результати й документи в [Отримати результати](https://docs.anivahealth.com/uk/api/appointments/get-results.md) посилаються
на ці коди через `lab_code`.

## Повторні виклики

Aniva зберігає відповідь цього ендпойнта 5 хвилин для кожного API-ключа. Повторний виклик упродовж
цього часу отримує збережену відповідь. Заголовки `Cache-Status` і `Age` показують, що відповідь
збережена і як давно її збережено.

Щоб дізнаватися про зміни одразу, підпишись на події вебхуків `appointment.created`, `appointment.rescheduled` і подію кожного статусу, наприклад `appointment.confirmed`.
Див. [Повторні читання](https://docs.anivahealth.com/uk/concepts/webhooks.md#povtorni-chitannya).

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

| Статус | Опис |
| - | - |
| `400` | Неправильний параметр запиту, наприклад `date` не у форматі `YYYY-MM-DD`. |
| `403` | Доступ заборонено — твій API-ключ не має доступу до цієї операції або запитуваний профіль чи локація поза межами твоїх прав доступу. |
| `500` | Внутрішня помилка сервера. |

```bash cURL (all appointments) theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (one day at one location) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/appointments?date=2026-10-21&location_id=b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b' \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (by profile) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/appointments?profile_id=a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
[
  {
    "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T10:30:00Z",
    "status": "confirmed",
    "cancellation_reason": null,
    "results_ready_emails": [],
    "draw_method": "venous",
    "created_at": "2026-04-01T09:45:00Z",
    "updated_at": null,
    "profile": {
      "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": null
    },
    "panels": [
      {
        "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "added_at": "2026-04-01T09:50:00Z"
      }
    ],
    "individual_biomarkers": [
      {
        "biomarker_id": 42,
        "added_at": "2026-04-01T09:52:00Z"
      }
    ],
    "shipments": [
      {
        "id": "P2611194821",
        "added_at": "2026-04-15T07:00:00Z"
      }
    ],
    "lab_codes": []
  }
]
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.