---
title: "GET /annotations"
method: GET
path: "/annotations"
tags: ["annotations"]
---

# GET /annotations

`GET /annotations`

## Request

- Base URL: `https://api.axiom.co/v2`
- URL: `https://api.axiom.co/v2/annotations`
- Auth: OAuth 2
  - Authorization code: `https://accounts.google.com/o/oauth2/v2/auth`
  - Token URL: `https://www.googleapis.com/oauth2/v4/token` scopes: `annotations|read`
- TypeScript: <https://skmtc.dev/axiom/apis/axiom-public-api/docs/annotations/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists annotations in the organization. Filter by `datasets`, or by a time range with both `start` and `end` at most 100 days apart. Without filters, returns all annotations.

## Query parameters

- `datasets` string[]
- `start` string
- `end` string

## Response `200`

Annotations.

- Annotation[]
  - `datasets` string[], required: array<string> of dataset names for which the annotation appears on charts
  - `description` string: Explanation of the event the annotation marks on the charts
  - `endTime` string, date-time, nullable: End time of the annotation
  - `id` string, required
  - `time` string, date-time, required: Time the annotation marks on the charts. If you don't include this field, Axiom assigns the time of the API request to the annotation.
  - `title` string: Summary of the annotation that appears on the charts
  - `type` string, required: Type of the event marked by the annotation. Use only alphanumeric characters or hyphens. For example, "production-deployment".
  - `url` string: URL relevant for the event marked by the annotation. For example, link to GitHub pull request.

## Other responses

- `400`: Invalid `start` or `end`, only one of them set, `end` before `start`, or a range longer than 100 days.

## Changes

- **2026-10-16** (v2) `fbc1b8430feb`: 1 info
  - added the non-success response with the status `400`

[Operation history](https://skmtc.dev/axiom/apis/axiom-public-api/changes/annotations/get.md)

---

[API](https://skmtc.dev/axiom/apis/axiom-public-api.md) - [All operations](https://skmtc.dev/axiom/apis/axiom-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/axiom/apis/axiom-public-api/revisions/7e39a295e3ba?raw)