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

# List signage templates

`GET /v1/signage-templates`

## Request

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

Return the signage template instances in this workspace.

## Query parameters

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

## Response `200`

Success.

- object
  - `data` SignageTemplate[], required
    - `id` string, required: Signage template id.
    - `spaceId` string, required
    - `name` string, required
    - `config` object, required: The template configuration: `archetype`, `style`, `palette`, `orientation`, `content`, and the `schemaVersion` the API stamps on every write.
    - `nodeId` string, nullable, required
    - `masterId` string, nullable, required: The master template it was copied from, if any.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).
  - `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/02fd3665dc7d?raw)
