---
title: "List annotations"
method: GET
path: "/workspaces/{workspace_id}/projects/{project_id}/annotations"
tags: ["Annotations"]
---

# List annotations

`GET /workspaces/{workspace_id}/projects/{project_id}/annotations`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/annotations`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

List annotations in a project, optionally filtered by target.

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
- `project_id` integer, required: Project ID of the workspace

## Query parameters

- `target_type` string, nullable: Filter by resource type: dataset, dataview, or workflow
- `target_id` integer, nullable: Filter by resource ID

## Response `200`

Request fulfilled, document follows

- AnnotationResponse[]
  - `id` integer, required
  - `target_type` string, required
  - `target_id` integer, required
  - `project_id` integer, required
  - `status` string, required
  - `resolved_by` integer, nullable
  - `resolved_at` string, nullable
  - `created_by` integer, required
  - `created_at` string, nullable
  - `comments` AnnotationCommentResponse[]
    - `id` integer, required
    - `annotation_id` integer, required
    - `body` string, required
    - `created_by` integer, required
    - `created_at` string, nullable

## Other responses

- `400`: Bad request syntax or unsupported method

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/4b2c943a00dc?raw)