---
title: "Get a highlight"
method: GET
path: "/highlights/{id}"
tags: ["Highlights"]
---

# Get a highlight

`GET /highlights/{id}`

## Request

- Base URL: `https://api.screvi.com/api/v1`
- URL: `https://api.screvi.com/api/v1/highlights/{id}`
- Auth: API key in header `X-API-Key`

Returns a single highlight by ID, including its source and tags.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `include_metadata` boolean

## Response `200`

The requested highlight

- object
  - `data` Highlight
    - `id` string, uuid
    - `content` string: The highlight text
    - `note` string, nullable: User note attached to the highlight
    - `favorite` boolean
    - `url` string, nullable
    - `location` number, nullable: Position in the source (Kindle location, page, or offset)
    - `date` string, date-time, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `tags` Tag[]
      - `id` string, uuid
      - `name` string
      - `color` string, nullable
    - `source` HighlightSource
      - `id` string, uuid
      - `name` string
      - `type` 'book' | 'article' | 'tweet' | 'self' | 'podcast' | 'video' | 'custom' | 'youtube' | 'pdf'
      - `author` string, nullable
      - `image_url` string, nullable
      - `url` string, nullable
    - `metadata` object: Free-form JSON stored with the highlight. Only returned when `include_metadata=true`.

## Other responses

- `401`: Missing or invalid API key
- `404`: Highlight not found

---

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