---
title: "Get a screenshot template design"
method: GET
path: "/screenshot-templates/designs/{id}"
tags: ["Media"]
---

# Get a screenshot template design

`GET /screenshot-templates/designs/{id}`

## Request

- Base URL: `https://app.openpo.st/api/v1`
- URL: `https://app.openpo.st/api/v1/screenshot-templates/designs/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `openpost_session`

## Path parameters

- `id` string, required

## Response `200`

OK

- ScreenshotTemplateDesignResponse
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `can_edit` boolean, required
  - `document` ScreenshotTemplateDocument, required
    - `appearance` 'light' | 'dark', required
    - `conversation` ScreenshotTemplateConversation
      - `messages` ScreenshotTemplateMessage[], required
        - `id` string, required
        - `image_media_id` string
        - `sender_id` string, required
        - `text` string, required
      - `name` string, required
      - `people` ScreenshotTemplatePerson[], required
        - `avatar_media_id` string
        - `id` string, required
        - `name` string, required
      - `read_receipt` string, required
      - `self_id` string, required
      - `show_header` boolean, required
      - `timestamp` string, required
    - `frame` 'natural' | 'square' | 'portrait', required
    - `meme` ScreenshotTemplateMeme
      - `alt_text` string
      - `captions` string[], required
      - `format` 'png' | 'webp' | 'gif', required
      - `name` string, required
      - `overlay_media_ids` string[], required
      - `overlay_slots` integer, required
      - `parent_media_id` string
      - `template_id` string, required
    - `receipt` ScreenshotTemplateReceipt
      - `address` string, required
      - `business` string, required
      - `currency` 'USD' | 'EUR' | 'GBP' | 'BRL' | 'JPY', required
      - `custom_total` string, required
      - `footer` string, required
      - `items` ScreenshotTemplateReceiptItem[], required
        - `amount_cents` integer, required
        - `id` string, required
        - `name` string, required
        - `quantity` integer, required
      - `order` string, required
      - `tax_percent` number, double, required
      - `timestamp` string, required
    - `schema_version` 1, required
    - `status_page` ScreenshotTemplateStatus
      - `headline` string, required
      - `name` string, required
      - `severity` 'operational' | 'degraded' | 'outage', required
      - `updates` ScreenshotTemplateStatusUpdate[], required
        - `id` string, required
        - `stage` string, required
        - `text` string, required
        - `timestamp` string, required
    - `template_id` 'messages' | 'group-chat' | 'receipt' | 'status-page' | 'meme', required
    - `text_size` 'small' | 'normal' | 'large', required
    - `title` string, required
  - `id` string, required
  - `revision` integer, required
  - `template_id` string, required
  - `title` string, required
  - `updated_at` string, date-time, required
  - `workspace_id` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/openpo/apis/openpost-api.md) · [All operations](https://skmtc.dev/openpo/apis/openpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openpo/apis/openpost-api/revisions/67d3964458a7?raw)