---
title: "List Highlights"
method: GET
path: "/v1/highlights"
tags: ["Highlights"]
---

# List Highlights

`GET /v1/highlights`

## Query parameters

- `task_id` string, nullable

## Response `200`

Success

- ListHighlightsResponse
  - `highlights` HighlightMetadata[], required
    - `id` string, required
    - `event_type` string, nullable
    - `custom_category_name` string, nullable
    - `event_description` string, nullable
    - `event_timestamp_seconds` number, nullable
    - `edit_length` number, nullable
    - `inclusion_reasoning` string, nullable
    - `created_at` string, nullable
    - `otio_edit` object, nullable
    - `target_team` string, nullable
    - `target_players` string[], nullable
    - `otio_crop` object, nullable
    - `source_archive` object, nullable
    - `source_window` object, nullable
    - `render_windows` object[], nullable
    - `editor_state` object, nullable
    - `editor_revision` integer, nullable
    - `editor_project_id` string, nullable
    - `fight_number` integer, nullable
    - `round_number` integer, nullable
    - `fight_name` string, nullable
    - `event_metadata` object, nullable
  - `total` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/narrative-sports/apis/narrative-sports-api.md) · [All operations](https://skmtc.net/narrative-sports/apis/narrative-sports-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/narrative-sports/narrative-sports-api/versions/6a222f10647c/schema)