---
title: "List Annotations"
method: GET
path: "/data/v1/annotations"
tags: ["Annotations"]
---

# List Annotations

`GET /data/v1/annotations`

Returns a list of annotations.

## Query parameters

- `limit` integer
- `page` integer
- `order_direction` 'asc' | 'desc'
- `timeframe[]` string[]

## Response `200`

OK

- ListAnnotationsResponse
  - `data` Annotation[], required
    - `id` string, uuid, required — Unique identifier for the annotation
    - `note` string, required — The annotation note content
    - `date` string, date-time, required — Datetime when the annotation applies
    - `sub_property_id` string, nullable — Customer-defined sub-property identifier
  - `total_row_count` integer, required — Total number of annotations available
  - `timeframe` integer[] — Start and end unix timestamps for the data range

---

[API](https://skmtc.net/muxinc/apis/mux-api.md) · [All operations](https://skmtc.net/muxinc/apis/mux-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/muxinc/mux-api/revisions/34a65dce0f31/schema)
