---
title: "List captions"
method: GET
path: "/projects/{projectId}/captions"
tags: ["Captions and Themes"]
---

# List captions

`GET /projects/{projectId}/captions`

## Request

- Base URL: `https://blitzreels.com/api/v1`
- URL: `https://blitzreels.com/api/v1/projects/{projectId}/captions`
- Auth: API key in header `Authorization`

List captions.

## Path parameters

- `projectId` string, required

## Query parameters

- `limit` number
- `offset` number

## Response `200`

Successful response

- object
  - `success` boolean, required
  - `captions` object[], required
    - `caption_id` string, required
    - `timeline_item_id` string, nullable, required
    - `project_id` string, required
    - `text` string, required
    - `start_units` number, nullable, required
    - `end_units` number, nullable, required
    - `start_seconds` number, nullable, required
    - `end_seconds` number, nullable, required
    - `words` object[], required
      - `id` string, required
      - `word` string, required
      - `order_index` number, required
      - `start_units` number, nullable, required
      - `end_units` number, nullable, required
      - `start_seconds` number, nullable, required
      - `end_seconds` number, nullable, required
      - `paragraph_index` number, nullable, required
      - `is_emphasis` boolean, required
      - `style` object, nullable, required
        - `offsetX` number, nullable
        - `offsetY` number, nullable
        - `rotationDeg` number, nullable
        - `scale` number, nullable
        - `fontFamily` string, nullable
        - `fontWeight` string, nullable
        - `color` string, nullable
        - `activeColor` string, nullable
        - `backgroundColor` string, nullable
        - `activeAnimation` 'none' | 'slide-from-bottom' | 'pop' | 'glow' | 'punch', nullable
        - `fontStyle` 'normal' | 'italic', nullable
        - `textTransform` 'none' | 'uppercase', nullable
        - `letterSpacing` number, nullable
        - `opacity` number, nullable
        - `textStrokeColor` string, nullable
        - `textStrokeWidthPx` number, nullable
        - `textStrokeBlurPx` number, nullable
        - `textShadow` string, nullable
        - `glowColor` string, nullable
        - `glowBlurPx` number, nullable
        - `textGradientFrom` string, nullable
        - `textGradientTo` string, nullable
        - `textGradientAngleDeg` number, nullable
        - `backgroundRadiusPx` number, nullable
        - `emojiName` string, nullable
        - `emojiScale` '1' | '2' | '0.5', nullable
        - `isSpecial` boolean, nullable
        - `isKeyword` boolean, nullable
        - `lineBreakBefore` boolean
  - `pagination` object, required
    - `total` number, required
    - `returned` number, required
    - `offset` number, required
    - `limit` number, required
    - `has_more` boolean, required

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

---

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