Skip to Content
Mux Docs: Home
List Annotations
get

Returns a list of annotations.

Request path & query params
limit
integer
(default: 25)

Number of items to include in the response

page
integer
(default: 1)

Offset by this many pages, of the size of limit

order_direction
string
Possible values: "asc""desc"

Sort order.

timeframe[]
array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).

Accepted formats are...

  • array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
  • duration string e.g. timeframe[]=24:hours or timeframe[]=7:days
get
200
/data/v1/annotations
Response
(application/json)
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "This is one note",
      "date": "2025-04-23T19:10:00Z",
      "sub_property_id": "123456"
    },
    {
      "id": "234e4567-e89b-12d3-a456-426614174000",
      "note": "This is another note",
      "date": "2025-04-23T19:20:00Z",
      "sub_property_id": null
    }
  ],
  "total_row_count": 2,
  "timeframe": [
    1745434800,
    1745438400
  ]
}