---
title: "Get a layout thumbnail"
method: GET
path: "/v1/layouts/{id}/thumbnail"
tags: ["layouts"]
---

# Get a layout thumbnail

`GET /v1/layouts/{id}/thumbnail`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/layouts/{id}/thumbnail`
- Auth: HTTP bearer

Retrieve a preview image of a layout, showing each zone at its real position filled with a still of its content. The same image is used everywhere the layout is previewed. Add `?fresh=1` to regenerate it after an edit.

## Path parameters

- `id` string, required

## Query parameters

- `fresh` '1'

## Response `200`

Success. The body is the file itself.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No such layout in this workspace.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)
