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

# List banners

`GET /v1/banners`

## Request

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

List the announcement banners this workspace has created for display inside the content management system, including each banner's title, body, tone, audience, and active state.

## Query parameters

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

## Response `200`

Success.

- object
  - `data` Banner[], required
    - `id` string, required
    - `spaceId` string, required
    - `title` string, required
    - `body` string, nullable, required
    - `tone` 'info' | 'success' | 'warning' | 'critical', required
    - `audience` object, required: Free-form JSON the screens use to pick the banner (default `{}`).
    - `active` boolean, required
    - `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)