---
title: "Get the patient's pinned health targets with details"
method: GET
path: "/patients/{patient_id}/health-targets/pinned/details"
tags: ["health_targets"]
---

# Get the patient's pinned health targets with details

`GET /patients/{patient_id}/health-targets/pinned/details`

## Path parameters

- `patient_id` integer, required

## Query parameters

- `date_since` string — calendar date in format YYYY-MM-DD
- `date_until` string — calendar date in format YYYY-MM-DD

## Response `200`

successful operation

- PatientHealthTargetDetailsResponse[]
  - `data` PatientHealthDataTableResponse
    - `aggregation_fn` string[], nullable
    - `category` string, required
    - `data_cols` PatientHealthDataTableResponseDataCols
      - `group` string[]
    - `field` union
      - string
      - string[]
    - `grouper` union
      - string
      - string[]
    - `has_more_rows` boolean, nullable
    - `rows` object[], nullable
  - `target` PatientHealthTargetResponse
    - `archive_reason` 'changed' | 'deleted', nullable
    - `archived_time` string, date-time, nullable
    - `category` string, required
    - `created_by_user_id` number
    - `created_by_user_type` 'clinician' | 'patient' | 'system'
    - `created_time` string, date-time
    - `id` integer, nullable
    - `is_pinned` boolean, nullable
    - `meal_slots` string[], nullable
    - `patient_id` integer, required
    - `target_aggregator` 'avg' | 'min' | 'max' | 'sum' | 'count'
    - `target_name` string, required
    - `target_period` string — Allowed values depend on the target category. Nutrient and water targets use week, day, breakfast, lunch, dinner, snack, and meal. Other categories use their category-specific supported periods.
    - `target_range_high` number, nullable — upper end of the range; patient wants to stay below this value
    - `target_range_low` number, nullable — lower end of the range; patient wants to stay above this value
    - `target_range_type` 'above' | 'below' | 'within'
    - `updated_time` string, date-time

---

[API](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server.md) · [All operations](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/llms.txt) · [OpenAPI document](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/revisions/750cc0d96a93?raw)