---
title: "List annotations"
method: GET
path: "/v1/projects/{projectId}/annotations"
tags: ["analytics"]
---

# List annotations

`GET /v1/projects/{projectId}/annotations`

## Request

- Base URL: `https://api.prodantix.com`
- URL: `https://api.prodantix.com/v1/projects/{projectId}/annotations`
- Auth: HTTP bearer

The project's annotations whose days overlap from to to, both YYYY-MM-DD and inclusive. Name a report to add that report's own annotations to the project's.

## Path parameters

- `projectId` string, required

## Query parameters

- `reportId` string
- `from` string, required
- `to` string, required

## Response `200`

The annotations, earliest first

- object
  - `annotations` AnnotationBody[], required
    - `id` string, required
    - `reportId` string, nullable
    - `startsOn` string, required
    - `endsOn` string, required
    - `text` string, required
    - `tags` string[], required
    - `createdByName` string, nullable
    - `createdAt` string, required
    - `updatedAt` string, required
    - `canChange` boolean, required

## Other responses

- `400`: The request does not describe an annotation
- `403`: The caller may not do this
- `404`: The project, report or annotation is not there

---

[API](https://skmtc.dev/prodantix/apis/prodantix-api.md) · [All operations](https://skmtc.dev/prodantix/apis/prodantix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/prodantix/apis/prodantix-api/revisions/fde6615df5a1?raw)