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

# List platform banners

`GET /v1/platform-banners`

## Request

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

List notices shown at the top of every page in the content management system. Returns every active, non-deleted notice for this workspace; apply the display window and the audience yourself. Notices a signed-in person has already dismissed are left out for that person, so an API key gets every notice.

**Notes.**
- Every active notice is returned, whatever its display window; filter on `startsAt`, `endsAt` and `audience` yourself. Notices for another account are never returned.
- Dismissing a notice needs a signed-in person, so an API key always gets the notices a person may have dismissed.

## Response `200`

Success.

- object
  - `data` object[], required
    - `id` string, required
    - `tone` 'info' | 'success' | 'warning' | 'promo', required
    - `title` string, required
    - `message` string, required
    - `cta` object, nullable, required: A call-to-action link, or null.
      - `label` string, required
      - `href` string, required
    - `dismissible` boolean, required
    - `audience` object, required: Who the notice is for: `everyone`, `role`, `tier`, `min-online-screens` or `account`. Apply the audience and the display window yourself.
      - `kind` string, required
    - `startsAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `endsAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `active` boolean, required
    - `createdAt` string, required: ISO-8601 timestamp (UTC).

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