---
title: "List layouts"
method: GET
path: "/v1/layouts"
tags: ["layouts"]
---

# List layouts

`GET /v1/layouts`

## Request

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

List the workspace's multi-zone layouts, including each layout's name, resolution, and zone count.

## Query parameters

- `limit` integer
- `cursor` string
- `count` '1'
- `usableAt` string

## Response `200`

Success.

- object
  - `data` Layout[], required
    - `id` string, required: Layout id.
    - `spaceId` string, required
    - `name` string, required
    - `resolution` object, required: Design canvas size in pixels.
      - `w` number, required
      - `h` number, required
    - `zones` object[], required: Zones: geometry, bound content, frame, radius and role. `GET /v1/layouts/{id}/zones` returns the same list.
    - `autoFullscreenForVideo` boolean, nullable, required
    - `approvalState` 'draft' | 'pending' | 'approved' | 'rejected', required: Review state. Editing an approved row returns it to `draft`.
    - `approvedSnapshot` string, nullable, required: JSON TEXT of the last approved version (not parsed).
    - `nodeId` string, nullable, required
    - `importSourceId` string, nullable, required
    - `theme` unknown, required
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `usedByScreenCount` integer, required: Screens showing this layout now, directly or through a playlist or schedule.
  - `nextCursor` string, nullable: Present when `?limit` was passed. Send it back as `?cursor=` for the next page; null on the last page.
  - `total` integer: Total matching rows, when the route computes it.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `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/7c2741bcdb16?raw)