---
title: "List a layout's zones"
method: GET
path: "/v1/layouts/{id}/zones"
tags: ["layouts"]
---

# List a layout's zones

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

## Request

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

List a layout's zones, including the content attached to each one.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` LayoutZone[], required
    - `id` string, required
    - `name` string, required
    - `x` number, required: Left edge, in layout pixels.
    - `y` number, required
    - `w` number, required
    - `h` number, required
    - `locked` boolean, required
    - `contentName` string: Label of the bound content. Absent on the zone a new layout starts with.
    - `content` object, nullable: What the zone plays: a media file, playlist, schedule, app, web link or creative (`canvas`).
      - `kind` 'media' | 'playlist' | 'schedule' | 'app' | 'link' | 'canvas', required
      - `id` string, required
      - `name` string, required
    - `zIndex` number
    - `ownerScope` 'workspace' | 'org_unit' | 'location'
    - `ownerNodeId` string, nullable
    - `frame` 'bare' | 'card' | 'accent' | 'glass': Paint style on a themed layout.
    - `radius` number: Corner radius in layout pixels.
    - `role` 'logo': `logo`: the zone shows the Brand Kit logo instead of content.

## 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)