---
title: "Get Project Highlight Options"
method: GET
path: "/v1/projects/{project_id}/highlight-options"
tags: ["Projects"]
---

# Get Project Highlight Options

`GET /v1/projects/{project_id}/highlight-options`

## Request

- Base URL: `https://api.narrative-sports.com`
- URL: `https://api.narrative-sports.com/v1/projects/{project_id}/highlight-options`
- Auth: HTTP bearer

## Path parameters

- `project_id` integer, required

## Response `200`

Success

- HighlightOptionsResponse
  - `project_id` integer, required
  - `project_name` string, nullable
  - `event_types` CountOption[], required
    - `value` string, required
    - `count` integer, required
    - `otio_ready_count` integer, required
  - `teams` CountOption[], required
    - `value` string, required
    - `count` integer, required
    - `otio_ready_count` integer, required
  - `players` CountOption[], required
    - `value` string, required
    - `count` integer, required
    - `otio_ready_count` integer, required
  - `fights` FightOption[], required
    - `fight_number` integer, required
    - `fight_name` string, nullable
    - `count` integer, required
    - `otio_ready_count` integer, required
    - `round_numbers` integer[], required
    - `highlight_ids` string[], required
  - `highlights` HighlightOption[], 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
    - `target_team` string, nullable
    - `target_players` string[], nullable
    - `fight_number` integer, nullable
    - `round_number` integer, nullable
    - `fight_name` string, nullable
    - `otio_ready` boolean, required
  - `total_highlights` integer, required
  - `otio_ready_highlights` integer, required

## Other responses

- `422`: Validation Error

---

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