> ## 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.

# List Appointments

> Retrieve blood draw appointments accessible to your API key

Retrieve a list of blood draw appointments. Each appointment includes the embedded patient profile.

When `profile_id` is provided, returns all appointments for that profile with no time restriction. When omitted, returns all accessible appointments within a default time window (past 2 months to future 1 month).

<Note>Requires `test_sessions_view` or `test_sessions_schedule` scope.</Note>

## Request

### Query parameters

<ParamField query="profile_id" type="string">
  Filter by profile UUID. When provided, all appointments for this profile are returned regardless
  of scheduling date. When omitted, the default time window applies.
</ParamField>

## Response

On success, the API returns `200 OK` with an array of appointment objects.

<ResponseField name="id" type="string" required>
  Unique appointment identifier (UUID).
</ResponseField>

<ResponseField name="profile_id" type="string" required>
  UUID of the profile this appointment belongs to.
</ResponseField>

<ResponseField name="location_id" type="string">
  UUID of the test location. `null` for home kit appointments.
</ResponseField>

<ResponseField name="scheduled_at" type="string">
  Scheduled appointment datetime as a UTC instant (ISO 8601 with `Z` suffix, e.g.
  `2026-05-15T10:30:00Z`). May be `null`.
</ResponseField>

<ResponseField name="status" type="string" required>
  Current appointment status. One of `pending`, `confirmed`, `blood_drawn`, or `cancelled`.
  Lab-result completion granularity is derived from [Get Results](/api/appointments/get-results);
  finer-grained shipment progression from each entry in the inline `shipments` array (see below)
  followed to [Get Shipment](/api/shipments/get-shipment).
</ResponseField>

<ResponseField name="test_method" type="string">
  Method used for the blood draw. One of `practitioner` or `home`. May be `null`.
</ResponseField>

<ResponseField name="cancellation_reason" type="string">
  Free-text reason captured when the appointment was cancelled (e.g. no-show, late cancellation,
  'Failed. Repeat required'). `null` unless `status` is `cancelled`.
</ResponseField>

<ResponseField name="created_at" type="string" required>
  ISO 8601 timestamp of when the appointment was created.
</ResponseField>

<ResponseField name="updated_at" type="string">
  ISO 8601 timestamp of the last update. May be `null`.
</ResponseField>

<ResponseField name="profile" type="object" required>
  The patient profile associated with this appointment.

  <Expandable title="profile">
    <ResponseField name="id" type="string">
      Unique profile identifier (UUID).
    </ResponseField>

    <ResponseField name="handle" type="string">
      Profile handle or username. May be `null`.
    </ResponseField>

    <ResponseField name="first_name" type="string">
      First name. May be `null`.
    </ResponseField>

    <ResponseField name="last_name" type="string">
      Last name. May be `null`.
    </ResponseField>

    <ResponseField name="email" type="string">
      Email address. May be `null`.
    </ResponseField>

    <ResponseField name="phone" type="string">
      Phone number in E.164 format. May be `null`.
    </ResponseField>

    <ResponseField name="sex" type="integer">
      Biological sex per ISO/IEC 5218. May be `null`.
    </ResponseField>

    <ResponseField name="date_of_birth" type="string">
      Date of birth in `YYYY-MM-DD` format. May be `null`.
    </ResponseField>

    <ResponseField name="height" type="number">
      Height in centimeters. May be `null`.
    </ResponseField>

    <ResponseField name="weight" type="number">
      Weight in kilograms. May be `null`.
    </ResponseField>

    <ResponseField name="language" type="string">
      Preferred language (`en`, `de`, or `fi`).
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the profile was created.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of the last profile update. May be `null`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="panels" type="AppointmentPanel[]" required>
  Panels currently attached to this appointment. Excludes cancelled attachments. Look up panel
  details (name, biomarkers) via [List Panels](/api/panels/list-panels).

  <Expandable title="Panel attachment fields">
    <ResponseField name="panel_id" type="string">
      Panel UUID — cross-reference against [List Panels](/api/panels/list-panels).
    </ResponseField>

    <ResponseField name="added_at" type="string">
      ISO 8601 timestamp the panel was first attached to this appointment.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="individual_biomarkers" type="AppointmentIndividualBiomarker[]" required>
  À-la-carte biomarkers attached to this appointment outside any panel (see [Add Custom
  Biomarkers](/api/appointments/add-individual-biomarkers)). Cross-reference each `biomarker_id`
  against [List Biomarkers](/api/biomarkers/list-biomarkers) for display data.

  <Expandable title="Individual biomarker fields">
    <ResponseField name="biomarker_id" type="integer">
      Biomarker identifier — cross-reference against
      [List Biomarkers](/api/biomarkers/list-biomarkers).
    </ResponseField>

    <ResponseField name="added_at" type="string">
      ISO 8601 timestamp the biomarker was first attached to this appointment.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="shipments" type="AppointmentShipmentLink[]" required>
  Shipments linked to this appointment, oldest-link first. Empty array when no shipments are
  linked. Cross-reference each `id` against [Get Shipment](/api/shipments/get-shipment) for the
  full shipment payload (status, tracking number, status updates, etc.).

  <Expandable title="Shipment link fields">
    <ResponseField name="id" type="string">
      Shipment reference identifier — cross-reference against
      [Get Shipment](/api/shipments/get-shipment).
    </ResponseField>

    <ResponseField name="added_at" type="string">
      ISO 8601 timestamp the shipment was first linked to this appointment.
    </ResponseField>
  </Expandable>
</ResponseField>

## Error responses

| Status | Description                                                                                                                 |
| ------ | --------------------------------------------------------------------------------------------------------------------------- |
| `403`  | Forbidden — your API key does not have access to this operation, or the requested profile is outside your permission scope. |
| `500`  | Internal server error.                                                                                                      |

<RequestExample>
  ```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 (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'
  ```
</RequestExample>

<ResponseExample>
  ```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",
      "test_method": "practitioner",
      "cancellation_reason": null,
      "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",
        "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": "P2604154821",
          "added_at": "2026-04-15T07:00:00Z"
        }
      ]
    }
  ]
  ```

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