---
title: "Get presentation"
method: GET
path: "/api/v1/presentations/{presentation_id}"
tags: ["Presentations"]
---

# Get presentation

`GET /api/v1/presentations/{presentation_id}`

## Request

- Base URL: `https://api.pitch.com`
- URL: `https://api.pitch.com/api/v1/presentations/{presentation_id}`
- Auth: one of:
  - API key in header `X-API-KEY`
  - HTTP bearer

Get a presentation by ID: its editor and player URLs plus metadata; pass include_content=true for the content as Markdown, or include_images=true for the images placed on its slides.

## Path parameters

- `presentation_id` string, uuid, required

## Query parameters

- `include_content` boolean
- `include_metadata` boolean
- `include_variables` boolean
- `include_images` boolean
- `include_hidden_slides` boolean

## Response `200`

- object
  - `data` object, required
    - `presentation_id` string, uuid, required: UUID of the presentation.
    - `title` string, required: The presentation's title.
    - `editor_url` string, required: URL that opens the presentation in the Pitch editor.
    - `player_url` string, required: URL that opens the presentation in the Pitch player.
    - `markdown` string: The presentation's textual content as Markdown.
    - `variables` object[]: The presentation's in-use variables.
    - `images` object[]: The images placed on the presentation's slides, in slide order.
      - `slide_id` string, uuid, required: UUID of the slide the image is placed on.
      - `slide_number` integer, nullable, required: The slide's position among visible slides; null for a hidden slide.
      - `url` string, required: The image's URL, without its query string. Pitch-hosted images are served through Pitch's image CDN, fit within 2000x2000; third-party images keep their original URL.
      - `library_name` string, nullable, required: The asset's name in the workspace media library; null for images that aren't in it.
    - `metadata` object
      - `breadcrumb` union[], required: Where the presentation lives: the teamspace or private space that holds it first, then each folder on the way down, ending with its immediate parent folder. A presentation at the top level of its space has a single element. Folders are omitted when the caller may read the presentation but not the folders around it.
        - union
          - object: The teamspace the content lives in. Pass the id as move-content's target_teamspace_id to move content here.
            - `name` string, nullable, required: The teamspace's name, null when it is hidden from the caller.
            - `teamspace_id` string, uuid, required
          - object: The private space the content lives in.
            - `name` string, required
            - `private_space` unknown, required
            - `owner_id` string, uuid: Set when the private space is not the caller's own.
          - object: A folder on the way from the space down to the content. Pass the id as move-content's target_folder_id to move content here.
            - `name` string, required
            - `folder_id` string, uuid, required
      - `owner` object, nullable, required: The user whose private space holds the presentation; null for teamspace presentations.
        - `id` string, uuid, required
        - `name` string, nullable, required
      - `author` object, nullable, required
        - `id` string, uuid, required
        - `name` string, nullable, required
      - `created_at` string, date-time, nullable, required
      - `last_edited_at` string, date-time, nullable, required: When the deck's contents last changed.
      - `last_edited_by` object, nullable, required: The editor behind that last change.
        - `id` string, uuid, required
        - `name` string, nullable, required

## Other responses

- `400`
- `401`
- `403`
- `404`

---

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